前置作業 / 取得發票字軌號碼 / 取得發票字軌號碼區間

應用場景

此API取得的發票字軌號碼，形式為回傳一組發票號碼區間，內容包含字軌、發票起訖號碼等。如果特店在開立發票時，只需要知道可開立的字軌號碼區間並且後續可自行組成電子發票內容，可選擇此API做串接。

API介接網址

正式環境：https://einvoice.ecpay.com.tw/B2CInvoice/GetOfflineInvoiceWordSetting
測試環境：https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetOfflineInvoiceWordSetting

HTTPS 傳輸協定

Content Type ：application/json
HTTP Method ：POST

特店傳入參數(Json格式)

PlatformID String(10)
特約合作平台商代號

PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。

MerchantID String(10)
特店編號 必填

RqHeader Object
傳入資料 必填

Timestamp String(10)
傳入時間

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

注意事項：

驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次API request將無法建立，參考資料：http://www.epochconverter.com/。
特店需進行主機「時間校正」，避免主機產生時差，造成API request失敗。

Data String
加密資料 必填

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

特店傳入參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": "1525168923",
        "Revision": "1.0.0"
    },
    "Data": "加密資料"
}

Data參數說明(Json格式)

MerchantID String(10)
特店編號 必填

InvoiceYear String(3)
發票年度 必填

僅可設定當年與明年

InvoiceTerm Int
發票期別 必填

不可帶入小於當年期別

1: 1-2月
2: 3-4月
3: 5-6月
4: 7-8月
5: 9-10月
6: 11-12月

InvoiceStatus Int
發票字軌狀態 必填

1:啟用
2:備用字軌

MachineID String(10)
發票機台ID 必填

Data參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "InvoiceYear": "109",
    "InvoiceTerm": 1,
    "InvoiceStatus": 1,
    "MachineID": "A123456"
}

綠界回傳參數(Json格式)

PlatformID String(10)
特約合作平台商代號

MerchantID String(10)
特店編號

RpHeader Object
傳入資料

Timestamp String(10)
傳入時間

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

TransCode Int
回傳代碼

1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功，實際的 API 執行結果狀態請參考 RtnCode。

TransMsg String(200)
回傳訊息

回傳訊息

Data String
加密資料

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

綠界回傳參數範例

				
					{
    "MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": "1525169058"
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "加密資料"
}

Data參數(Json格式)

RtnCode Int
回應代碼

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

InvoiceHeader String(2)
發票字軌

InvoiceStart String(8)
起始發票編號

InvoiceEndString(8)
結束發票編號

InvoiceStatus Int
發票字軌狀態

1:啟用
2:備用字軌

Times Int
已取次數

相同字軌,已取用的次數

回傳Data參數範例

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功",
    "InvoiceHeader": "AA",
    "InvoiceStart": "10000000 ",
    "InvoiceEnd": "10000049",
    "InvoiceStatus": 1,
    "Times": 1
}

綠界官方網站