技術文件
使用對象
本區提供 API 與技術說明,供串接與技術對接使用。適用於資訊人員、開發團隊,以及需與 e首發票進行 API 或檔案介接之營業人或合作廠商。
文件索引
| 項目 | 說明 | 連結 |
|---|---|---|
| e首發票 API 說明與開發注意事項 | 開立/作廢/折讓 API 入口、Swagger UI 連結與端點一覽、OpenAPI 規格、簽章、導入前確認、開發注意事項、情境與 API 對應一覽 | API 說明與開發注意事項 |
| F0401 欄位對應表 | 財政部展開 XML 存證欄位說明;程式設計時欄位與屬性主要參考,命名與型態對應 | F0401_欄位對應表 |
| 發票開立檢核作業 | 開立 F0401 存證前之正確性檢核規則:稅別、B/C 類、銷售額與稅額、統編檢查碼、載具、上傳時限、雲端歸戶等 | 發票開立檢核作業 |
| OpenAPI 規格(YAML) | 開立發票、作廢發票、折讓電子發票之 OpenAPI 3.0 規格 | einvoice-api-openapi.yaml |
| OpenAPI 規格(JSON) | 同上內容,JSON 格式;若 YAML 中文顯示亂碼請改用此檔 | einvoice-api-openapi.json |
| 情境與 API 對應(歸檔) | 發票版/訂單版/機台/混合各情境使用之 API 與說明文件位置 | 取號管理差異與選型 §情境與 API 說明對應 |
正式規格與合約以 e首發票公告與雙方合約為準。
版本紀錄
| 版本 | 日期 | 修改者 | 修改內容 |
|---|---|---|---|
| v1.0 | 2025-02-10 | 專案負責人 | 建立技術文件總覽。 |
| v1.1 | 2025-02-10 | 專案負責人 | 新增 API 說明與開發注意事項、OpenAPI 3.0 規格。 |
| v1.2 | 2025-02-10 | 專案負責人 | 新增 F0401 欄位對應表;重構總覽頁結構。 |