查詢特定多筆發票(開發中)

應用場景

特店可使用此API查詢各種類別多筆發票資訊，綠界提供Json/CSV格式回傳。

應用流程

此API採用分頁顯示的回傳機制，查詢結果會依照開立發票的時間由新到舊(e.g: 2022/10/12, 2022/10/01, 2022/09/01, 2022/07/06…)進行排序，以下說明API呼叫步驟程序：

Step1. 執行第一次API呼叫，設定每頁回傳筆數-[NumPerPage]及設定顯示的頁數-[ShowingPage，固定帶1]，即取得綠界回應的資料總筆數-[TotalCount]。

Step2. 根據Step1取得的資料總筆數-[TotalCount]，以及所需的分頁筆數來決定API的查詢次數

例如：當TotalCount=300，分頁需求為每頁100筆，則需呼叫3次取回所有資料(如下表所示)

API 呼叫	[ShowingPage] 參數值	[NumPerPage] 參數值
第一次	1	100
第二次	2	100
第三次	3	100

API介接網址

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

HTTPS傳輸協定

Content Type ：application/json
HTTP Method ：POST

特店傳入參數(Json格式)

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

這個參數是專為與綠界簽約的指定平台商所設計，只有在申請開通後才能使用。
如果您是一般廠商，請在介接時將此參數欄位保留為空。
對於平台商，在使用時需要在MerchantID(特店編號)欄位中填入與您已經完成綁定子廠商的MerchantID(特定編號)。
請注意，只能使用已綁定的子廠商編號，以避免操作失敗。綁定作業請洽所屬業務。

MerchantID String(10)
特店編號 必填

RqHeader Object
傳入資料 必填

Timestamp Number
傳入時間 必填

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

注意事項：

驗證時間區間暫訂為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。

Data String
加密資料 必填

此為加密過JSON格式的資料。加密方法說明

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

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

Data參數說明(Json格式) : 請先將Json字串進行urlencode後再進行AES加密

MerchantID String(10)
特店編號 必填

BeginDate String(10)
查詢起始日期 必填

要查詢的發票開立開始日期
格式為「yyyy-MM-dd」or「yyyy/MM/dd」

EndDate String(10)
查詢結束日期 必填

要查詢的發票開立結束日期
格式為「yyyy-MM-dd」or「yyyy/MM/dd」

NumPerPage Int
單頁顯示筆數 必填

注意事項：單頁上限為200筆。為了保證系統效能和響應速度，建議每頁的顯示筆數不要超過30筆。

ShowingPage Int
顯示的頁數 必填

注意事項：查詢結果資料，會根據第一次開立發票的時間，按時間序較新排列至較舊的

DateType Int
日期類型 必填

1：發票日期
2：建檔日期

DataType Int
回傳資料類型 必填

1：Json
2：CSV

InvoiceType Int
查詢發票類型 必填

1：用發票號碼
2：用發票區間

InvoiceCategory Int
發票種類 必填

0：銷項
1：進項

InvoiceNumber String(10)
發票號碼

當 InvoiceType = 1 時，此欄位必填

InvoiceStart String(10)
起始發票號碼

當 InvoiceType = 2 時，此欄位必填

InvoiceEnd String(10)
結束發票號碼

當 InvoiceType = 2 時，此欄位必填

RelateNumber String(50)
廠商自訂編號

SendMethod String(1)
寄送類別

0：全部(預設)
1：交換
2：存證

InvStatus String(1)
開立狀態

0：全部(預設)
1：已開立
2：已作廢
3：已退回

UploadStatus String(1)
上傳狀態

0：全部(預設)
1：已上傳
2：未上傳
3：上傳失敗

ApprovalStatus String(1)
買方確認狀態

SendMethod = 2 時，此參數值不會被用於篩選查詢資料

0：全部(預設)
1：已確認
2：未確認

CustomerIdentifier String(8)
買方統編

CustomerName String(60)
買方公司名稱

SellerIdentifier String(8)
賣方統編

SellerName String(60)
賣方公司名稱

Data參數範例(Json格式)

				
					{
   "MerchantID": "2000132",
   "BeginDate": "2025-10-28",
   "EndDate": "2025-11-10",
   "NumPerPage": 200,
   "ShowingPage": 2,
   "DataType": 1,
   "InvoiceType":1,
   "InvoiceCategory":1,
   "InvoiceNumber":"AB12345678"
}

綠界回傳參數格式

Content Type ：application/json
HTTP Method ：POST

綠界回傳參數(Json格式)

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

MerchantID String(10)
特店編號

RpHeader Object
回傳資料

Timestamp Number
回傳時間

Unix timestamp(GMT+8)

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格式) : 請先將Data進行AES解密後再做urldecode

RtnCode Int
回應代碼

1 代表 API 執行成功，其餘代碼均為失敗。

RtnMsg String(200)
回應訊息

TotalCount Number
總筆數

ShowingPage Int
顯示的頁數

InvoiceData Array[Object]
發票資料

InvoiceNumber String(10)
發票號碼

RelateNumber String(50)
特店自訂編號

TaxType Int
課稅別

1：應稅
2：零稅率
3：免稅
4：應稅(特種稅率)
9：若為混合應稅與免稅或零稅率

TotalAmount Number
發票金額

支援整數12位

TaxAmount Number
營業稅額

支援整數11位

BalanceAmount Number
剩餘可折讓金額

支援整數12位

TaxRate Number
稅率

小數點2位

Buyer_Identifier String(8)
買方統編

Buyer_Name String(60)
買方名稱

Buyer_Address String(100)
買方地址

Buyer_TelephoneNumber String(26)
買方電話

Buyer_EmailAddress String(200)
買方電子信箱

Buyer_FacsimileNumber String(26)
買方傳真號碼

InvoiceDate String(10)
發票開立日期

格式為「yyyy-MM-dd」或「yyyy/MM/dd」

Upload_Date String(20)
發票上傳時間

若B2B發票種類[InvoiceCategory]=1，此欄位為null

Upload_Status String(1)
發票上傳狀態

若B2B發票種類[InvoiceCategory]=1，此欄位為空值

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

Issue_Status String(1)
發票開立狀態

0：發票退回
1：發票開立

CustomsClearanceMark String(1)
通關方式註記

注意事項：

只有零稅率才會回傳以下資料
1：非經海關出口
2：經海關出口

ZeroTaxRateReason String(2)
零稅率原因

自115年1月1日起，當課稅類別[TaxType]為2(零稅率)時，此欄位必填或廠商後台必須設定以便程式抓取，否則將會開立失敗，其值如下
71：第一款外銷貨物
72：第二款與外銷有關之勞務，或在國內提供而在國外使用之勞務
73：第三款依法設立之免稅商店銷售與過境或出境旅客之貨物
74：第四款銷售與保稅區營業人供營運之貨物或勞務
75：第五款國際間之運輸。但外國運輸事業在中華民國境內經營國際運輸業務者，應以各該國對中華民國國際運輸事業予以相等待遇或免徵類似稅捐者為限
76：第六款國際運輸用之船舶、航空器及遠洋漁船
77：第七款銷售與國際運輸用之船舶、航空器及遠洋漁船所使用之貨物或修繕勞務78：第八款保稅區營業人銷售與課稅區營業人未輸往課稅區而直接出口之貨物
79：第九款保稅區營業人銷售與課稅區營業人存入自由港區事業或海關管理之保稅倉庫、物流中心以供外銷之貨物

CustomerNumber String(20)
客戶編號

買方公司編號

RandomNumber String(4)
隨機碼

MainRemark String(200)
備註

ExchangeMode String(1)
發票開立方式

0: 存證，綠界會將您的發票資料上傳至財政部，僅適用於銷項發票。
※加值中心無法接收其他營業人開立給您的電子發票
1: 交換，綠界會將發票資料上傳至財政部發票傳輸軟體供對方營業人確認及接收。

ExchangeStatus String(1)
發票確認狀態

若為空值表示未設定

0：未確認
1：已確認

Seller_Identifier String(8)
賣方統編