コンプライアンス・アーカイブ
PDF/A-3b ハイブリッド請求書向け ZUGFeRD API
公開 gPdf E-Invoice Render エンドポイントを使い、EN 16931 CII XML を埋め込んだ ZUGFeRD PDF/A-3b 請求書を生成します。
主 API E-Invoice Render
ENDPOINT
/api/v1/e-invoice/render 対象システム ERP / 請求処理基盤 / ドイツ向け財務ワークフロー / コンプライアンス自動化サービス
解決する業務課題
ERP または請求システムが正しい請求書データを準備した後、請求書PDF出力を EN 16931 CII XML 埋め込みの ZUGFeRD PDF/A-3b としてパッケージ化します。
この API が合う場合
- 公開 E-Invoice Render エンドポイントからネイティブの ZUGFeRD 出力が必要な場合。
- 対象請求書の有効な EN 16931 CII XML を自社システムですでに持っている場合。
- ZUGFeRD メタデータと関連ファイルの接続設定を含む PDF/A-3b パッケージングが必要な場合。
- より広い電子請求書ページや Factur-X ページと並ぶ、明確な関連ページが必要な場合。
置き換えないもの
- ネイティブの XRechnung 生成やポータル送信が必要な場合。
- gPdf に税計算、請求書の意味づけ推定、会計記録からの XML 生成を任せたい場合。
- 公開 OpenAPI 仕様に記載されていない標準が必要な場合。
呼び出す endpoint
/api/v1/e-invoice/render
E-Invoice Render がこのワークフローの標準パスです。
/api/v1/e-invoice/capabilities
関連 API パス、テンプレート契約、または機能確認が必要な場合に使います。
最小リクエスト
POST /api/v1/e-invoice/render - 最小限の ZUGFeRD パッケージ形状。
{
"settings": {
"profile": "pdfa-3b",
"e_invoice": {
"standard": "zugferd",
"profile": "en16931",
"document_type": "invoice",
"xml": {
"format": "cii",
"encoding": "utf8",
"content": "<rsm:CrossIndustryInvoice>...</rsm:CrossIndustryInvoice>"
}
}
},
"pages": [
{
"size": "a4",
"elements": [
{
"type": "text",
"x": 20,
"y": 24,
"content": "ZUGFeRD invoice",
"style": { "font_size": 16, "font_family": "NotoSans-Regular" }
}
]
}
]
}
gPdf が担当すること
- E-Invoice Render による ZUGFeRD パッケージング。
- ハイブリッド請求書出力向け PDF/A-3b プロファイル処理。
- CII XML を ZUGFeRD メタデータ付きの関連ファイルとして埋め込む処理。
- ドキュメントどおりのインライン PDF またはオブジェクト配信の挙動。
自社システムが担当すること
- EN 16931 CII XML の正確性、請求書データ、税務ロジック、買い手と売り手の意味づけ。
- 外部検証、受信者要件、ポータル送信、法的解釈。
- 再試行の挙動、保存、監査証跡、顧客への送付。
本番前チェックリスト
- settings.e_invoice.standard = zugferd、settings.e_invoice.profile = en16931 を設定します。
- CII XML では format = cii、encoding = utf8 を使います。
- settings.profile を pdfa-3b に設定するか、省略して電子請求書のデフォルトを使います。
- 返却された PDF を自社の ZUGFeRD 検証ワークフローで検証します。
- XRechnung やポータル送信の処理は、このエンドポイントの外に置きます。
対応範囲の境界
- このページは E-Invoice Render による ZUGFeRD 出力を対象にしています。
- ネイティブの XRechnung 生成をうたうものではありません。
- 請求書の業務データと XML の妥当性は自社システムが担います。
ZUGFeRD は E-Invoice Render 経路で使用します
ZUGFeRD は別のルートエンドポイントではありません。POST /api/v1/e-invoice/render の settings.e_invoice.standard フィールドで選択します。責任境界も同じです。gPdf は PDF/A-3b ハイブリッド請求書をパッケージ化し、請求書の事実情報と XML の妥当性は自社システムが担います。
FAQ
- どのエンドポイントで ZUGFeRD をレンダリングしますか？
- POST /api/v1/e-invoice/render を使い、settings.e_invoice.standard を zugferd に設定します。
- このページは XRechnung も対象ですか？
- いいえ。このページは公開 ZUGFeRD 仕様に限定しています。ここでは XRechnung をネイティブ出力として扱っていません。
- gPdf は CII XML を作成しますか？
- 自社システムが EN 16931 CII XML を渡し、その正確性を担います。
- 結果を検証できますか？
- 自社の ZUGFeRD 検証ワークフローを使い、検証の前提確認には gPdf の validator ページを参照してください。