發票查詢

應用場景

特店(營業人)可使用此API查詢已開立發票資訊,包括銷項發票及進項發票,綠界會以回傳參數方式回覆該張發票資料。此方式可協助特店(營業人)將查詢發票機制整合至營業人網站,提供快速查詢服務。

API介接網址

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

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

InvoiceCategory Int
B2B發票種類 必填

  • 0:銷項發票,查詢特店開給交易相對人的發票明細
  • 1:進項發票,查詢交易相對人開給特店的發票明細

InvoiceNumber String(10)
發票號碼 必填

InvoiceDate String(20)
發票開立日期 必填

格式為:yyyy-mm-dd

RelateNumber String(20)
自訂編號

均為唯一值不可重覆使用

Data參數範例 (Json格式)

				
					{
    "MerchantID": "2000132",
    "InvoiceCategory": 0,
    "InvoiceNumber": "SA37758327",
    "InvoiceDate": "2019-08-31",
    "RelateNumber": "2019081602"
}

				
			

綠界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)
特店編號

InvoiceNumber String(10)
發票號碼

InvoiceDate String(10)
發票開立日期

格式為:yyyy-mm-dd

RelateNumber String(20)
自訂編號

均為唯一值不可重覆使用

Buyer_Identifier String(8)
買方統編

Buyer_Name String(60)
買方名稱

Buyer_Address String(100)
買方地址

Buyer_TelephoneNumber String(26)
買方電話

Buyer_EmailAddress String(80)
買方電子信箱

Buyer_FacsimileNumber String(26)
買方傳真號碼

Seller_Identifier String(8)
賣方統編

若B2B發票種類[InvoiceCategory]=0,此欄為空值

Seller_Name String(60)
賣方名稱

若B2B發票種類[InvoiceCategory]=0,此欄為空值

Seller_Address String(100)
賣方地址

若B2B發票種類[InvoiceCategory]=0,此欄為空值

Seller_TelephoneNumber String(26)
賣方電話

若B2B發票種類[InvoiceCategory]=0,此欄為空值

Seller_EmailAddress String(80)
賣方電子信箱

若B2B發票種類[InvoiceCategory]=0,此欄為空值

Seller_FacsimileNumber String(26)
賣方傳真號碼

若B2B發票種類[InvoiceCategory]=0,此欄為空值

CustomsClearanceMark String(1)
通關方式註記

  • 1:非經海關出口
  • 2:經海關出口

InvoiceType String(2)
字軌類別

  • 07:一般稅額計算
  • 08:特種稅額計算

TaxType Int
課稅別

  • 1:一般應稅
  • 2:零稅率
  • 3:免稅
  • 4:特種應稅

TaxRate Number
稅率

SpecialTaxType String(1)
特種稅額類別  

數字【1-8】分別代表以下類別與稅率:

  • 【1】代表酒家及有陪侍服務之茶室、咖啡廳、酒吧之營業稅稅率,稅率為25%
  • 【2】代表夜總會、有娛樂節目之餐飲店之營業稅稅率,稅率為15%
  • 【3】代表銀行業、保險業、信託投資業、證券業、期貨業、票券業及典當業之專屬本業收入(不含銀行業、保險業經營銀行、保險本業收入)之營業稅稅率,稅率為2%
  • 【4】代表保險業之再保費收入之營業稅稅率,稅率為1%
  • 【5】代表銀行業、保險業、信託投資業、證券業、期貨業、票券業及典當業之非專屬本業收入之營業稅稅率,稅率為5%
  • 【6】代表銀行業、保險業經營銀行、保險本業收入之營業稅稅率(適用於民國103年07月以後銷售額) ,稅率為5%
  • 【7】代表銀行業、保險業經營銀行、保險本業收入之營業稅稅率(適用於民國103年06月以前銷售額) ,稅率為5%
  • 【8】代表空白為免稅或非銷項特種稅額之資料

SalesAmount Number
銷售額合計

回傳整數,最多12位

TaxAmount Number
營業稅額

回傳整數,最多11位

TotalAmount Number
發票金額

回傳整數,最多12位

IP String(15)
發票開立IP

IPV4

CreateDate String(20)
建檔時間

格式為:yyyy-mm-dd hh:mm:ss

Issue_Status String(1)
發票開立狀態

  • 0:發票退回
  • 1:發票開立

Upload_Status String(1)
上傳狀態

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

  • 0:未上傳
  • 1:已上傳
  • 2:上傳失敗

Upload_Date String(20)
上傳時間

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

ConfirmDate String(20)
發票確認時間

  • 格式為 yyyy-mm-dd
  • 若未作設定,此欄位為null

Invalid_Status String(1)
發票作廢狀態

  • 0:未作廢
  • 1:已作廢

ExchangeMode String(1)
發票開立方式

  • 0:存證
  • 1:交換

ExchangeStatus String(1)
發票確認狀態

若為空值表示未設定

  • 0:未確認
  • 1:已確認

BalanceAmount Number
剩餘可折讓金額

回傳整數,最多12位

MainRemark String(200)
發票備註

RandomNumber String(4)
隨機碼

四碼的隨機數字

Items Array[Object]
傳入資料

ItemSeq String(3)
商品明細排列序號

ItemName String(256)
商品名稱

ItemCount Number
商品數量

ItemWord String(6)
商品單位

商品單位最多是6碼

ItemPrice Number
商品價格

回傳最多整數10位,小數7位,固定顯示未稅價

ItemAmount Number
商品合計

回傳最多整數12位,小數7位

ItemTax Number
商品稅額 

回傳整數,最多11位

ItemRemark String(40)
商品備註 

RtnData參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "InvoiceNumber": "VG11000002",
    "InvoiceDate": "2019-08-31",
    "RelateNumber": "2019081602",
    "Buyer_Identifier": "11456006",
    "Buyer_Name": "黃黑糖的店",
    "Buyer_Address": "200基隆市仁愛區200基隆市仁愛區200基隆市仁愛區",
    "Buyer_TelephoneNumber": "02-12344321",
    "Buyer_EmailAddress": "abc@sunup.net",
    "Buyer_FacsimileNumber": "",
    "Seller_Identifier": "",
    "Seller_Name": "",
    "Seller_Address": "",
    "Seller_TelephoneNumber": "",
    "Seller_EmailAddress": "",
    "Seller_FacsimileNumber": "",    
    "CustomsClearanceMark": "1",
    "InvoiceType": "07",
    "TaxType": 1,
    "TaxRate": 0.05,
    "SalesAmount": 952,
    "TaxAmount": 48,
    "TotalAmount": 1000,
    "IP": 2130706433,
    "CreateDate": "2019-09-03 13:57:07",   
    "Issue_Status": "1",
    "Invalid_Status": "0",
    "Upload_Status": "1",
    "Upload_Date": "2019-09-03 14:57:07",
    "ConfirmDate": "2019-09-03 15:57:07",
    "ExchangeStatus": "1",
    "ExchangeMode": "0",
    "BalanceAmount": 952,
    "MainRemark": "",
    "RandomNumber": "6686",
    "Items": [
        {
            "ItemSeq": "1",
            "ItemName": "手機測試",
            "ItemCount": 1,
            "ItemWord": "支",
            "ItemPrice": 952,
            "ItemAmount": 952,
            "ItemTax": 48,
            "ItemRemark": ""
        }
    ]
}

				
			

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站