發票查詢 / 查詢作廢折讓發票

應用場景

特店(營業人)可使用此API查詢已作廢折讓發票資訊，綠界會以回傳參數方式回覆該張發票資料。此方式可協助特店(營業人)將查詢發票作廢折讓機制整合至營業人網站，提供快速查詢服務。

API介接網址

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

特店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)
特店編號 必填

AllowanceNo String(16)
綠界折讓編號 必填

長度固定為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)
綠界折讓編號

長度固定為16碼

AllowanceNumber String(16)
廠商折讓單號碼

廠商自訂折讓單號碼

SellerId String(8)
賣方統編

BuyerId String(8)
買方統編

CancelDate String(20)
作廢日期

格式為 yyyy-mm-dd

CancelReason String(20)
作廢原因

Upload_Status String(1)
上傳狀態

若B2B發票種類[InvoiceCategory]=0，此參數不顯示

0：未上傳
1：已上傳
2：上傳失敗

Upload_Date String(20)
上傳時間

格式為 yyyy-mm-dd
若B2B發票種類[InvoiceCategory]=0，此參數不顯示

ExchangeStatus String(1)
發票確認狀態

若為空值表示未設定

0：未確認
1：已確認

Remark String(200)
備註

RtnData參數範例(Json格式)

				
					{
    "MerchantID": "200132",
    "AllowanceNo": "1909241702402030",
    "AllowanceNumber": "19092234024023330",
    "SellerId": "23165448",
    "BuyerId": "", 
    "CancelDate": "2019-09-25",
    "CancelReason": "",  
    "Upload_Status": "",
    "Upload_Date": "null",
    "ExchangeStatus": "1",
    "Remark": ""
}

綠界官方網站