應用場景
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2BInvoice/GetAllowance
- 正式環境：https://einvoice.ecpay.com.tw/B2BInvoice/GetAllowance
特店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格式)
注意事項：請在加密前對參數值進行 URLEncode
MerchantID String(10)
特店編號 必填
AllowanceNo String(16)
綠界折讓編號 必填
Data參數範例 (Json格式)
{
"MerchantID": "2000132",
"AllowanceNo": "1909241702402030"
}
綠界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": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "…"
}
Data參數說明(Json格式)
RtnCode Int
回應代碼
1 為成功，其餘為失敗
RtnMsg String(200)
回應訊息
RtnData String
回應資料
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "查詢成功",
"RtnData": "…"
}
RtnData參數說明(Json格式)
MerchantID String(10)
特店編號
AllowanceNo String(16)
綠界折讓編號
AllowanceNumber String(16)
廠商折讓單號碼
AllowanceType String(20)
折讓類型
Buyer_Identifier String(8)
買方統編
Buyer_Name String(60)
買方名稱
Buyer_Address String(100)
買方地址
Buyer_TelephoneNumber String(26)
買方電話
Buyer_EmailAddress String(200)
買方電子信箱
Seller_Identifier String(8)
賣方統編
Seller_Name String(60)
賣方名稱
AllowanceDate String(20)
折讓單日期
TotalAmount Number
折讓金額總計(未稅)
回傳整數，最多12位
TaxAmount Number
營業稅額
回傳整數，最多11位。
IP String(15)
折讓開立IP
Upload_Status String(1)
上傳狀態
若B2B發票種類[InvoiceCategory]=1，此欄為空值
- 0: 未上傳
- 1: 已上傳
- 2: 上傳失敗
Upload_Date String(20)
上傳時間
- 格式為 yyyy-mm-dd
- 若B2B發票種類[InvoiceCategory]=1，此欄為null
ConfirmDate String(20)
退回確認日期
- 格式為 yyyy-mm-dd
- 若未作設定，此欄為null
Invalid_Status String(1)
作廢狀態
- 0: 未作廢
- 1: 已作廢
ExchangeStatus String(1)
發票確認狀態
若為空值表示未設定
- 0: 未確認
- 1: 已確認
Items Array[Object]
傳入資料
OriginalInvoiceDate String(20)
原發票日期
格式為 yyyy-mm-dd hh:mm:ss
OriginalInvoiceNumber String(10)
原發票號碼
OriginalSequenceNumber String(3)
發票商品明細排序
- 請帶1~999的整數值
- 商品排序需與原發票開立時的商品排序相同
OriginalDescription String(500)
原商品名稱
InvoiceType String(2)
字軌類別
- 07：一般稅額計算
- 08：特種稅額計算
TaxType Int
課稅別
- 1：一般應稅
- 2：零稅率
- 3：免稅
- 4：特種應稅
AllowanceSequenceNumber String(3)
折讓單排序
Quantity Number
商品數量
回傳最多整數8位，小數7位
Unit String(6)
商品單位
商品單位最多是6碼
UnitPrice Number
商品價格
回傳最多整數10位，小數7位
Tax Number
商品稅額
回傳整數，最多11位。
Amount Number
商品合計
回傳最多整數12位，小數7位
BalanceAmount Number
發票可折讓金額
回傳整數，最多12位。
Remark String(200)
備註
RtnData參數範例(Json格式)
{
"MerchantID": "2000132",
"AllowanceNo": "1909241702402030",
"AllowanceNumber": "1909241702402030",
"AllowanceType": "2",
"Buyer_Identifier": "23165448",
"Buyer_Name": "綠化肥肥化灰",
"Buyer_Address": "100臺北市中正區",
"Buyer_TelephoneNumber": "02-26551775",
"Buyer_EmailAddress": "abc1234@gmail.com",
"Seller_Identifier": "12345671",
"Seller_Name": "綠界科技BETA綠界科技BETA股份有限公司",
"AllowanceDate": "2019-09-24",
"TotalAmount": 24,
"TaxAmount": 1,
"IP": 2130706433,
"Upload_Status": "0",
"Upload_Date": "2019-09-24",
"ConfirmDate": "2019-09-25",
"Invalid_Status": "0",
"ExchangeStatus": "1",
"Items": [
{
"OriginalInvoiceDate": "2019-09-24 00:00:00",
"OriginalInvoiceNumber": "VG11000003",
"OriginalSequenceNumber": 1,
"OriginalDescription": "小浣熊",
"InvoiceType": "07",
"TaxType": 1,
"AllowanceSequenceNumber": 1,
"Quantity": 2,
"Unit": "粒",
"UnitPrice": 12,
"Tax": 1,
"Amount": 24,
"BalanceAmount": 0
}
] ,
"Remark": ""
}