iReceipt

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #go #android #machine-learning #deep-learning #awesome #kubernetes #awesome-list #security #open-source

(★ 13)

Generate Taiwan's electronic receipt including QR code, bar code, and XML for National Taxation Bureau

iReceipt 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# iReceipt

Generate Taiwan's electronic receipt including QR code, bar code, and XML for National Taxation Bureau. The spec. from National Taxation Bureau is trivial but very complicated and hard to read. iReceipt can save your life and time!!!

[![npm](https://img.shields.io/npm/dt/ireceipt.svg)](https://www.npmjs.com/package/ireceipt)
[![GitHub stars](https://img.shields.io/github/stars/kf99916/iReceipt.svg)](https://github.com/kf99916/iReceipt/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/kf99916/iReceipt.svg)](https://github.com/kf99916/iReceipt/network)
[![npm](https://img.shields.io/npm/v/ireceipt.svg)](https://www.npmjs.com/package/ireceipt)
[![GitHub license](https://img.shields.io/github/license/kf99916/iReceipt.svg)](https://github.com/kf99916/iReceipt/blob/master/LICENSE)

## Installation

```bash
npm install ireceipt --save
```

### Run in a Browser

Just leverage <a href="https://webpack.js.org/" target="_blank">Webpack</a> to bundle `IReceipt` to let `IReceipt` work in a browser.

## Usage

```javascript
import IReceipt from 'ireceipt';

const info = new IReceipt.ReceiptInfo(
        1234,
        new Date(),
        { id: '{{SELLER_ID}}', name: '{{SELLER_NAME}}' },
        { id: '{{BUYER_ID}}', name: '{{BUYER_NAME}}' },
        false
    ),
    items = [new IReceipt.Item('{{ITEM_DESCRIPTION}}', 3000, 1)],
    receipt = new IReceipt.Receipt(info, items),
    AESKey = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];

receipt
    .render(AESKey)
    .then(htmlString => {
        const win = window.open();
        win.document.body.innerHTML = htmlString;
    })
    .catch(err => {
        window.console.error('err', err);
    });

// toXmL
window.console.log(receipt.toXML());

// Taiwan Receipt Lottery
// The format of the list of winners:
// 53925591  10510LC60123189...
// 53925591  10510LC60122037...
const winnersList = IReceipt.Receipt.parseWinnersList('{{WINNERS_LIST}}');
window.console.log(receipt.isWinning(winnersList));
```

### Receipt

The receipt JavaScript object. It owns a `ReceiptInfo`, `Item`s and creates a `Amount` based on items.

`constructor(info, items)`

`info` `ReceiptInfo`  
`items` array of `Item`

#### Member Methods

`toXML()` Receipt object to xml string.  
`generateBarCodeString()` generate bar code string.  
`generateLeftQRCodeString(AESKey)` generate left QR code string including the receipt's information.
`generateRightQRCodeString()` generate right QR code string including information for all items.  
`renderRightQRCode()` generate right QR code svg string. return `Promise`.  
`renderLeftQRCode(AESKey)` generate left QR code svg string. return `Promise`.

`AESKey` the type is array (see the usage section) and the AES key is applied from National Taxation Bureau. More details: <a href="https://pjchender.blogspot.tw/2015/07/qrcodeaes.html" target="_blank">取得電子發票QRCODE中AES加密金鑰</a>

`renderBarCode()`generate bar code svg string. return `Promise`.  
`render(AESKey)` render Taiwan's electronic receipt. return `Promise`.

`AESKey` refer to `renderLeftQRCode(AESKey)`

### ReceiptInfo

Store the receipt information.

`constructor(number, date, seller, buyer, type, carrier, donationID, orderno)`

`number` receipt number  
`date` receipt date  
`seller` seller information, including id and name. (`{ id: '{{SELLER_ID}}', name: '{{SELLER_NAME}}' }`)  
`buyer` buyer information, including id and name. (`{ id: '{{BUYER_ID}}', name: '{{BUYER_NAME}}' }`)  
`type` receipt type (default `07`)  
`carrier` receipt carrier information, including id and type. (`{id: '{{CARRIER_ID}}', type:'CARRIER_TYPE'}`)  
`donationID` charity's love code (愛心碼)  
`orderno` order number

### Item

The product item buyed by buyer.

`constructor(description, unitPrice, sequenceNumber, quantity, taxType)`

`description` product item's description  
`unitPrice` unit price for a product item  
`sequenceNumber` sequence number  
`quantity` quantity of product items (default `1`)  
`taxType` tax type (default `TaxType.TAX`)

### Amount

Store the amount information.

`constructor(taxItems, freeTaxItems, zeroTaxItems)`

`taxItems` tax items  
`freeTaxItems` free tax items  
`zeroTaxItems` zero tax items

### TaxType

Tax type enum.

```js
{
    TAX: 1,
    ZERO_TAX: 2,
    FREE_TAX: 3,
    SPECIAL_TAX: 4,
    COMPOUND_TAX: 9
}
```

### EncodeType

Encode type for QR code enum.

```js
{
    BIG5: 0,
    UTF8: 1,
    BASE64: 3
}
```

## Reference

* <a href="https://www.einvoice.nat.gov.tw/" target="_blank">E-invoice Platform (財政部電子發票整合服務平台)</a>
* <a href="https://www.einvoice.nat.gov.tw/home/DownLoad?fileName=1479449792874_0.6(20161115).pdf" target="_blank">電子發票證明聯一維及二維條碼規格說明(V1.6)</a>
* <a href="https://www.einvoice.nat.gov.tw/home/DownLoad?fileName=1447235507091_0.zip" target="_blank">電子發票資料交換標準文件與範例(V3.1.2)</a>
* <a href="https://pjchender.blogspot.tw/2015/07/qrcodeaes.html" target="_blank">取得電子發票QRCODE中AES加密金鑰</a>

## Author

Zheng-Xiang Ke, kf99916@gmail.com

## Contributors

Sin-Fong Lyu, kingispeak@gmail.com

## License

iReceipt is available under the MIT license. See the LICENSE file for more info.

iReceipt

iReceipt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

iReceipt

iReceipt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README