應用場景
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2BInvoice/GetInvoiceWordSetting
- 正式環境：https://einvoice.ecpay.com.tw/B2BInvoice/GetInvoiceWordSetting
特店Request參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用，一般廠商介接請放空值。
- 平台商使用時，MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號，以免造成失敗。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳入資料 必填
Timestamp Number
傳入時間 必填
綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間
注意事項：
- 驗證時間區間暫訂為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。
Data String
加密資料 必填
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
特店Request參數範例 (Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "…"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
InvoiceYear String(3)
發票年度 必填
僅可查詢去年、當年與明年的發票年度，格式為民國年，例如：111
InvoiceTerm Int
發票期別 必填
- 0：全部
- 1：1-2月
- 2：3-4月
- 3：5-6月
- 4：7-8月
- 5：9-10月
- 6：11-12月
UseStatus Int
字軌使用狀態 必填
- 0：全部
- 1：未啟用
- 2：使用中
- 3：已停用
- 4：暫停中
- 5：待審核
- 6：審核不通過
InvoiceCategory Int
發票類別 必填
- 2：B2B，請固定填寫為2
InvType String(2)
字軌類別
- 07：一般稅額發票
- 08：特種稅額發票
InvoiceHeader String(2)
字軌名稱
Data參數範例(Json格式)
{
"MerchantID": 2000132,
"InvoiceTerm": 0,
"InvoiceYear": "111",
"UseStatus": 1,
"InvoiceCategory": 2
}
綠界Response參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp Number
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功，實際的 API 執行結果狀態請參考 RtnCode。
TransMsg String(200)
回傳訊息
Data String
加密資料
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
綠界Response參數範例 (Json格式)
{
"MerchantID": "3002607",
"RpHeader": {
"Timestamp": 1234564848
},
"TransCode": 1,
"TransMsg": "Success",
"Data": "…"
}
Data參數說明(Json格式)
RtnCode Int
回應代碼
1 為成功，其餘為失敗
RtnMsg String(200)
回應訊息
InvoiceInfo Array[Object]
發票資訊
TrackID String(10)
字軌號碼ID
InvoiceYear String(3)
發票年度
InvoiceTerm Int
發票期別
- 1：1-2月
- 2：3-4月
- 3：5-6月
- 4：7-8月
- 5：9-10月
- 6：11-12月
InvoiceCategory Int
發票類別
2:B2B
InvType String(2)
字軌類別
- 07：一般稅額發票
- 08：特種稅額發票
InvoiceHeader String(2)
字軌名稱
InvoiceHeader String(2)
字軌名稱
InvoiceStart String(8)
起始發票編號
InvoiceEnd String(8)
結束發票編號
InvoiceNo String(8)
目前已使用號碼
UseStatus Int
使用狀態
- 1：未啟用
- 2：使用中
- 3：已停用
- 4：暫停中
- 5：待審核
- 6：審核不通過
InvoiceLastDate String(20)
發票最後開立時間
格式為：yyyy-MM-dd HH:mm:ss
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "查詢成功"
"InvoiceInfo": {
"TrackID": "1234567890",
"InvoiceYear": "109",
"InvoiceTerm": 1,
"InvoiceCategory": 1,
"InvType": "07",
"InvoiceHeader": "AQ",
"InvoiceStart": "10000000",
"InvoiceEnd": "19999999",
"InvoiceNo": "12345678",
"UseStatus": 2,
"InvoiceLastDate": "2021-01-21 10:12:15"
},{
"TrackID": "1234569870",
"InvoiceYear": "109",
"InvoiceTerm": 1,
"InvoiceCategory": 1,
"InvType": "07",
"InvoiceHeader": "AQ",
"InvoiceStart": "10000000",
"InvoiceEnd": "19999999",
"InvoiceNo": "12345678",
"UseStatus": 2,
"InvoiceLastDate": "2021-01-21 10:12:15"
}
}