跳轉到
e首發票 e首發票 官方導入指南

發票查詢 API

對外服務 API 之「查詢」集中於 SwaggerInquire 分組,均為 POST並非 GET /v1/invoices/{id} 形式。路徑、Request Body 模型與回應欄位請以 Swagger UI 為準。


Inquire 端點一覽

路徑 摘要
/Inquire/GetInvoiceIDList 依公司與期別等條件查詢 發票號碼清單
/Inquire/GetInvoicesStatus 批次查詢發票處理狀態(是否已開立、作廢、上傳財政部等)
/Inquire/GetInvoicesAppendStatus 批次查詢發票 新增(Append) 是否成功寫入

為何沒有「REST 單筆 GET」敘述

若舊文件出現 GET /v1/invoices/...以訂單編號 Query String 列表,該設計不在本 Swagger v1 路徑清單中;請改以上列 Inquire 端點設計整合。


請求與認證

  • HeaderapiKey(見 認證與金鑰管理)。
  • Body:各端點使用不同模型(如 RequestAssagnNoModelRequestInvoiceStatus 陣列等),必填欄位與簽章 請於 Swagger 展開查閱。

查詢範例(結構示意)

POST https://{您的BaseURL}/Inquire/GetInvoicesStatus
apiKey: {您的KEY}
Content-Type: application/json

[
  {
    "...": "依 Swagger 定義 RequestInvoiceStatus 填寫"
  }
]

實際 JSON 為 陣列或包裝物件 以 Swagger Try it out 為準。


作廢與折讓(不在 Inquire)

作廢發票、折讓、作廢折讓等屬 Update 分組,例如:

路徑 摘要
/Update/CancelInvoices 批次作廢發票
/Update/AllowanceInvoice 新增折讓單
/Update/AllowanceInvoices 批次新增折讓單
/Update/CancelAllowance 作廢折讓單
/Update/CancelAllowances 批次作廢折讓單

參數為 CancelModelAllowanceModel 等,請以 Swagger 為準。


營運與稽核建議

  • 保留查詢條件、時間與回應,以利對帳與稽核。
  • 狀態與財政部上傳進度不同步時,應有 SOP 與人工補救流程。

責任邊界

查詢結果僅反映系統當下狀態;交易事實與申報責任仍由營業人與串接資料來源負責。


相關文件