技術文件
API 串接建議從這裡開始
互動式 API 文件（Swagger UI）：Product.EInvoice.WebApi — 對外服務 API（Stage）
可瀏覽完整端點、請求／回應結構並進行線上測試。開通申請、簽章、開發注意事項與情境對照，請見 API 說明與開發注意事項。
English documentation for integrators
For non–Chinese-speaking partners: Technical documentation (English) — API integration guide (Swagger-first), F0401 field mapping, invoice validation, and signing notes.
使用對象
本區提供 API 與技術說明，供串接與技術對接使用。適用於資訊人員、開發團隊，以及需與 e首發票進行 API 或檔案介接之營業人或合作廠商。
建議閱讀順序
| 步驟 | 項目 | 說明 | 連結 |
|---|---|---|---|
| 1 | API 說明與開發注意事項 | 開通申請、Swagger UI、端點一覽、簽章、開發注意、情境與 API 對照 | API 說明與開發注意事項 |
| 2 | F0401 欄位對應表 | 存證欄位路徑、型態、檢核說明（程式設計主要參考） | F0401_欄位對應表 |
| 3 | 發票開立檢核作業 | 開立前稅別、B/C、載具、上傳時限等規則 | 發票開立檢核作業 |
| 4 | 情境與 API 對應 | 發票版／訂單版／機台／混合各情境應使用的 API | 取號管理差異與選型 §情境與 API 說明對應 |
其他技術文件
| 項目 | 說明 | 連結 |
|---|---|---|
| English — API & integration | 境外／非中文語系：Swagger 優先之英文整合指南、F0401 完整表（英）、檢核作業（英） | Technical docs (English) |
| F0401 欄位對應表（英文完整表） | 與中文表相同列數；欄位語意與檢核說明英文化 | f0401-field-mapping.md |
| 發票開立檢核作業（英文） | 稅別、B/C、銷售額與稅額、統編檢查碼、載具、上傳時限、雲端歸戶（英） | invoice-issuance-validation.md |
| F0401 精簡欄位表（英文） | 常用／必填欄位快速查閱 | f0401-field-reference.md |
進階：機器可讀 OpenAPI 規格檔（工具匯入用，非一般閱讀入口）
若需將規格匯入 Postman、程式產碼或 CI，可下載下列檔案。一般串接請優先使用上方 Swagger UI。
| 語系 | 格式 | 連結 | 備註 |
|---|---|---|---|
| 中文 | JSON | einvoice-api-openapi.json | 境內串接；敘述為中文 |
| 英文 | JSON | einvoice-api-openapi.en.json | 境外串接；敘述為英文 |
正式規格與合約以 e首發票公告與雙方合約為準。Stage Swagger 為測試範例；正式環境 URL 與 KEY 依合約／服務商後台為準。
版本紀錄
| 版本 | 日期 | 修改者 | 修改內容 |
|---|---|---|---|
| v1.0 | 2025-02-10 | 專案負責人 | 建立技術文件總覽。 |
| v1.1 | 2025-02-10 | 專案負責人 | 新增 API 說明與開發注意事項、OpenAPI 3.0 規格。 |
| v1.2 | 2025-02-10 | 專案負責人 | 新增 F0401 欄位對應表；重構總覽頁結構。 |
| v1.3 | 2026-05-15 | SystemLead | 新增英文技術區入口、OpenAPI 英文檔索引。 |
| v1.4 | 2026-05-15 | SystemLead | 英文區補 F0401 完整表、發票開立檢核（英）；索引表增直連。 |
| v1.5 | 2026-06-08 | SystemLead | API 導覽改 Swagger UI 優先；OpenAPI 檔收至進階區；移除英文 YAML；建議閱讀順序表。 |
| v1.6 | 2026-06-08 | SystemLead | 移除中文 YAML；OpenAPI 僅保留 JSON（中／英）。 |