應用場景
交易雙方因發生銷貨退回或發票內容開立錯誤，特店(營業人)在與交易相對人(營業人)達成合意後，特店(營業人)傳送作廢發票參數給綠界，由綠界暫存相關資料。綠界會於隔日將發票作廢後上傳財政部電子發票整合服務平台，並根據發送通知API設定，通知交易相對人(營業人)電子發票已作廢。
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2BInvoice/Invalid
- 正式環境：https://einvoice.ecpay.com.tw/B2BInvoice/Invalid
特店Request參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用，一般廠商介接請放空值。
- 平台商使用時，MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號，以免造成失敗。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp String(10)
傳入時間 必填
綠界會利用此參數將當下的時間轉為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)
特店編號 必填
InvoiceNumber String(10)
發票號碼 必填
InvoiceDate String(10)
發票開立日期 必填
格式為：yyyy-mm-dd
Reason String(20)
作廢原因 必填
Remark String(200)
備註
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"InvoiceNumber": "VG11000002",
"InvoiceDate": "2019-09-23",
"Reason": "Invalid_Reason",
"Remark": "Seller_Invalid_Remark"
}
綠界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)
回應訊息
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "新增成功"
}