請求・財務
アカウントと請求エクスポート向けの明細書PDF API
複数ページにわたる明細行、合計、メタデータ、任意の PDF/A アーカイブ設定を備えた、アカウント・請求・利用履歴の明細書PDFを生成します。
主 API JSON Render
ENDPOINT
/api/v1/pdf/render 対象システム 課金バックエンド / アカウントシステム / ERP エクスポートサービス / SaaS レポートサービス
解決する業務課題
期間データ、期首残高、明細行、調整、合計から、顧客・アカウント・請求の明細書PDFを生成し、ユーザーが確認や保持のために一貫した記録をダウンロードできるようにします。
この API が合う場合
- 自社システム側で、すでに残高、明細書の期間、取引行、合計を管理している場合。
- 口座履歴、請求サマリー、財務業務向けの PDF エクスポートが必要な場合。
- ヘッダー、フッター、サマリーセクションを備えた、再現可能な複数ページ出力が必要な場合。
- アーカイブ業務向けに PDF/A 出力が必要になる可能性がある場合。
置き換えないもの
- 銀行連携、台帳照合、または金融助言が必要な場合。
- 暗号化された明細書と PDF/A を同じレンダリングリクエストで必要とする場合。公開 Render API は、セキュリティ設定と PDF/A プロファイル設定を相互排他として扱います。
- 電子インボイスの XML パッケージングが必要な場合。それには E-Invoice Render エンドポイントを使います。
呼び出す endpoint
/api/v1/pdf/render
JSON Render がこのワークフローの標準パスです。
/api/v1/template-render
関連 API パス、テンプレート契約、または機能確認が必要な場合に使います。
最小リクエスト
POST /api/v1/pdf/render - 期間合計付きの明細書の表紙ページ。
{
"settings": {
"profile": "pdfa-2b"
},
"pages": [
{
"size": "letter",
"elements": [
{
"type": "text",
"x": 18,
"y": 20,
"content": "Account Statement",
"style": { "font_size": 18, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 18,
"y": 38,
"content": "Period: 2026-05-01 to 2026-05-31\nOpening balance: $1,240.00\nClosing balance: $1,890.25",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
}
]
}
]
}
gPdf が担当すること
- DocumentRequest から明細書ページを生成すること。
- テキストブロック、表、合計セクション、ページ番号、メタデータ、PDF/A プロファイル設定。
- 安定した明細書レイアウトとフィールド仕様のための Template Render。
- 自社システムでのダウンロードや保存に適したバイナリ PDF 出力。
自社システムが担当すること
- 明細書の期間ロジック、口座残高、取引データ、通貨ルール、顧客識別。
- アーカイブポリシー、アクセス制御、ファイル命名、安全な配信。
- 消し込み、監査承認、規制対象となる金融上の表示・表明。
本番前チェックリスト
- 長い取引説明、多数の行、空の期間、マイナス残高をテストする。
- 明細書のレンダリングごとにリクエスト ID を生成する。
- オンデマンドでレンダリングするか、期間締め後に各明細書を保存するかを決める。
- 明細書のアーカイブポリシーが要求するときだけ PDF/A を使う。
- アクセス制御と顧客認証は、レンダリング API の外側に保つ。
対応範囲の境界
- gPdf は口座残高を計算したり、台帳を照合したりしません。
- API は明細書PDFを生成します。財務上の正しさは自社システムが担います。
- PDF/A 出力はレンダリング設定であり、保持ポリシーの代わりにはなりません。
明細書は期間を区切った文書
明細書ページは、確定した業務上の事実の集合から始めるべきです。アカウント、期間、期首残高、取引行、調整、期末残高です。gPdf はそれらの事実を決めません。ユーザーがダウンロードでき、自社システムが保存できる PDF レイアウトへ変換します。
多数の行を扱う
行数が多い場合は、表の領域、サマリーセクション、ページ番号を備えた、繰り返し使えるレイアウトとして明細書を設計します。レイアウトを調整している間は JSON Render を使います。フィールド仕様が安定したら Template Render へ移ります。
FAQ
- gPdf は明細書の残高を計算できますか？
- いいえ。自社システムが期間、残高、行、合計を送ります。gPdf は PDF を生成します。
- 明細書PDFで PDF/A を使えますか？
- はい。JSON Render は PDF/A プロファイル設定をサポートします。PDF/A が必須かどうかは、自社のアーカイブポリシーが決めます。
- 明細書は Template Render を使うべきですか？
- レイアウトが安定したあとは、通常はそうします。Template Render を使えば、呼び出し側はページ座標を繰り返さずに期間データを送れます。
- gPdf は明細書を保存しますか？
- いいえ。標準のレンダリングリクエストは PDF レスポンスを返します。保存とアクセス制御は自社システム側で管理します。