読み込み中
豆知識
一人社長の /tax-compliance を支える API の一覧です。パスは OpenAPI(/docs/api-reference)とフロントの endpoints.ts に合わせています。呼び出し時はサーバーの base(/api)付きで GET /api/consumption-tax/calculate のようになります。
詳細なリクエスト/レスポンスは Scalar の OpenAPI ブラウザを正とします。ここでは画面タブとエンドポイントの対応だけ示します。
タブ(?tab=) |
画面 | 主要エンドポイント |
|---|---|---|
filing |
法人税申告ウィザード | GET/PUT /tax-filing/session · GET /kakutei-shinkoku/init · GET /kakutei-shinkoku/preflight · POST /compliance/etax/generate-xtx |
process-map |
申告フロー | GET /kakutei-shinkoku/process-map · GET /kakutei-shinkoku/bank-gap |
consumption-tax |
消費税申告 | GET /consumption-tax/calculate · compare · eligibility · quarterly · filing-status · drill · form-data/:year |
comparison |
年度比較 | GET /filing-projection/diff · GET /filing-projection/snapshots |
workspace |
XTX/XML 管理 | GET/POST /filing-workspace/files · POST /compliance/etax/import-xtx/preview |
tools |
インボイス・届出・e-Tax 連携など | GET /compliance/invoice/verify · GET /compliance/etax/... · GET /tax/withholding/... |
整合性の横断チェックはタブではなく /check(旧 /review)と GET /integrity/snapshot · GET /findings 側です。
tab=filing)| メソッド | パス | 役割 |
|---|---|---|
GET / PUT |
/tax-filing/session |
ハブセッションの読込・保存 |
GET |
/kakutei-shinkoku/init |
年度の提出準備状況(複合) |
GET |
/kakutei-shinkoku/preflight |
生成前の整合性ゲート |
POST |
/kakutei-shinkoku/generate |
申告サマリ生成 |
POST |
/compliance/etax/generate-xtx |
法人税 XTX 生成 |
GET |
/compliance/etax/download-xtx/:sessionId |
XTX ダウンロード |
POST |
/tax-filing/print-bundle |
PDF + XTX + XML の ZIP |
ウィザードはユーザー向け 5 マクロステップ(内部 7 フェーズ)。消費税 XTX はここではなく tab=consumption-tax です。
tab=consumption-tax)| メソッド | パス | 役割 |
|---|---|---|
GET |
/consumption-tax/calculate |
課税売上・仕入税額の計算 |
GET |
/consumption-tax/compare |
方式比較(原則 / 簡易 / 二割・三割) |
GET |
/consumption-tax/eligibility |
適用可否 |
GET |
/consumption-tax/quarterly |
四半期集計 |
GET |
/consumption-tax/filing-status |
申告ステータス |
GET |
/consumption-tax/drill |
仕入税額控除の行レベル明細 |
GET |
/consumption-tax/form-data/:year |
申告書ビュー用フィールド |
GET |
/consumption-tax/quarterly-periods |
四半期期間一覧 |
仕入行への登録番号記録はレビュー API: POST /api/review/record-registration-number(申告前レビュー)。
| 領域 | 代表パス |
|---|---|
| 修正申告 | /filing-amendment/status · /filing-amendment/start · /filing-amendment/complete |
| 提出投影 | /filing-projection/current · /filing-projection/filed · /filing-projection/diff |
| ワークスペース | /filing-workspace/files · /compliance/etax/import-xtx/apply |
| 領域 | 代表パス |
|---|---|
| 源泉 | /tax/withholding/calculate · /tax/withholding/...(一覧・銀行紐付けなど) |
| 適格請求書番号 | /compliance/invoice/status · /compliance/invoice/verify · /compliance/invoice/verify-bulk |
| 法人番号 | /compliance/corporate-number/lookup |
/bank-statement)照合 API は /reconciliation/* 配下です(例: GET /reconciliation/unreconciled · POST /reconciliation/match)。税務ハブの /v1/tax/* というパスは存在しません。
税・会計の業務エラーは主に ERR_10xxx(例: ERR_10008 提出前ゲート失敗)。帯域の全体は エラーコード とバックエンドの src/utils/error-codes.ts を参照してください。
読み込み中
豆知識