仕訳CSV取得API
仕訳CSV取得API
1. API 概要
API名: 仕訳CSV取得API
目的: 外部システムと仕訳情報を連携するために必要なCSVデータを取得する。
概要: このAPIは、指定された条件に該当する仕訳情報が記載されたCSVデータを取得します。
2. リクエスト
2.1 リクエストURL
メソッド：GET
ドメイン：お問い合わせください。
エンドポイント：お問い合わせください。
2.2 リクエストヘッダー
| ヘッダー名 | 値 | 説明 |
|---|---|---|
| Content-Type | application/json | リクエストボディのフォーマット。 |
| Authorization | Bearer {access_token} | 認証トークン。 |
2.3 リクエストボディ
なし。
2.4 クエリパラメータ
| パラメータ名 | キー | 型 | 必須 | 説明 |
|---|---|---|---|---|
| 仕訳の種類 | journal_type |
string |
○ | 仕訳の種類(費用計上仕訳:1, 支払計上仕訳:2, 消費税計上仕訳:3) |
| 期間の開始日 | trading_start_date |
string |
○ | (取引日)期間の開始日(YYYY-MM-DD) |
| 期間の終了日 | trading_end_date |
string |
○ | (取引日)期間の終了日(YYYY-MM-DD) |
3. レスポンス
3.1 レスポンス成功時
ヘッダー
| ヘッダー名 | 値 | 説明 |
|---|---|---|
| Content-Type | text/csv |
レスポンスボディのフォーマット |
| Content-Disposition | name="attachment"; filename="journals.csv" |
コンテンツの処理方法 |
ステータスコード: 200 OK
3.2 レスポンス失敗時
ステータスコード: 400 Bad Request (入力が不正な場合)
| ステータスコード | エラーの種類 | 説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正な場合(例えば、必須パラメータの欠如、フォーマットエラーなど)。 |
| 403 | Forbidden | レスポンスが存在しない場合、Keycloakの認証エラー(全API共通)。 |
| 500 | Internal Server Error | サーバー側の問題。 |
4. 認証
このAPIには、認証が必要です。リクエストのヘッダーにBearerトークンを含めてください。
access_tokenは認証を通過したユーザーのアクセストークンです。
**Authorizationヘッダー**: `Bearer {access_token}`
5. 仕訳CSV出力項目
| No. | 項目名 | 形式 | 概要 |
|---|---|---|---|
| 1 | 仕訳ID | 文字列(最大255文字) | 仕訳ID。 |
| 2 | 取引区分 | 数字(最大4桁)、1:売上、2:入金、3:入金消込、4:費用、5:支払、6:売上（検収時）、7:費用（検収時） | 取引区分。 |
| 3 | 取引日 | YYYY/MM/DD | 取引日。 |
| 4 | 参照番号 | 文字列(最大50文字) | 取引区分に対応する参照番号。 |
| 5 | 参照番号枝番 | 数字(最大5桁)、空白 | 明細を特定するための枝番。 |
| 6 | 取引先企業コード | 文字列(最大255文字) | 取引先企業コード。 |
| 7 | 取引先企業名 | 文字列(最大255文字) | 取引先企業名。 |
| 8 | 会計連携用企業コード | 文字列(最大255文字) | 取引先の会計連携用企業コード。 |
| 9 | 分析用タグ | 文字列(最大50文字) | 画面から入力を行える分析用タグ。 |
| 10 | 借方勘定科目コード | 文字列(最大255文字) | 借方勘定科目コード。 |
| 11 | 借方勘定科目 | 文字列(最大255文字) | 借方勘定科目。 |
| 12 | 借方補助科目コード | 文字列(最大255文字) | 借方補助科目コード。 |
| 13 | 借方補助科目 | 文字列(最大255文字) | 借方補助科目。 |
| 14 | 借方税区分 | 文字列(課税（8%）/課税（10%）/免税/非課税/不課税) | 借方の税区分。 |
| 15 | 借方部署コード | 文字列(最大255文字) | 借方の部署コード。 |
| 16 | 借方部署名 | 文字列(最大255文字) | 借方の部署名。 |
| 17 | 借方会計連携用部署コード | 文字列(最大255文字) | 借方の会計連携用部署コード。 |
| 18 | 借方会計連携用部署名 | 文字列(最大255文字) | 借方の会計連携用部署名。 |
| 19 | 借方金額 | 数字(0-999999999999.000) | 借方金額。 |
| 20 | 貸方勘定科目コード | 文字列(最大255文字) | 貸方勘定科目コード。 |
| 21 | 貸方勘定科目 | 文字列(最大255文字) | 貸方勘定科目。 |
| 22 | 貸方補助科目コード | 文字列(最大255文字) | 貸方補助科目コード。 |
| 23 | 貸方補助科目 | 文字列(最大255文字) | 貸方補助科目。 |
| 24 | 貸方税区分 | 文字列(課税（8%）/課税（10%）/免税/非課税/不課税) | 貸方の税区分。 |
| 25 | 貸方部署コード | 文字列(最大255文字) | 貸方の部署コード。 |
| 26 | 貸方部署名 | 文字列(最大255文字) | 貸方の部署名。 |
| 27 | 貸方会計連携用部署コード | 文字列(最大255文字) | 貸方の会計連携用部署コード。 |
| 28 | 貸方会計連携用部署名 | 文字列(最大255文字) | 貸方の会計連携用部署名。 |
| 29 | 貸方金額 | 数字(0-999999999999.000) | 貸方金額。 |
| 30 | 金額（総額） | 数字(0-999999999999.000) | 総額。 |
| 31 | 摘要 | 文字列(最大1000文字) | 摘要。 |
| 32 | 税率 | 数字(最大２桁)、課税8%: 8, 課税10%: 10、空白 | 税率。仕訳出力設定が内税表示の場合のみ出力。 |
| 33 | 税勘定科目 | 文字列(仮払消費税/仮受消費税) | 税勘定科目。仕訳出力設定が内税表示の場合のみ出力。 |
| 34 | 取引件名 | 文字列(最大255文字) | 取引件名。 |
| 35 | 支払期日 | YYYY/MM/DD | 支払期日。支払依頼が行われたデータにのみ出力。 |
| 36 | 汎用コード1 | 文字列(最大255文字) | 選択された汎用コード1のコード。 |
| 37 | 汎用コードラベル1 | 文字列(最大255文字) | 選択された汎用コード1の名前。 |
| 38 | 汎用コード2 | 文字列(最大255文字) | 選択された汎用コード2のコード。 |
| 39 | 汎用コードラベル2 | 文字列(最大255文字) | 選択された汎用コード2の名前。 |
| 40 | 汎用コード3 | 文字列(最大255文字) | 選択された汎用コード3のコード。 |
| 41 | 汎用コードラベル3 | 文字列(最大255文字) | 選択された汎用コード3の名前。 |
| 42 | 通貨 | 文字列(最大50文字) | 通貨種別。日本円の場合は、"JPY"。 |
| 43 | 為替レート(JPY) | 数字(0-999999999999.000)、空白 | 外貨レート（JPY）。 |
| 44 | 参考借方金額(JPY) | 数字(0-999999999999.000)、空白 | 借方金額を外貨を日本円に換算した場合の参考金額。 |
| 45 | 参考貸方金額(JPY) | 数字(0-999999999999.000)、空白 | 貸方金額を外貨を日本円に換算した場合の参考金額。 |
| 46 | カスタム項目(明細) | JSON | 出力例） [{"groupName": "入力グループA-1","groupCode": "code1","isShared": false,"fields": [{"code": "x001","label": "カスタム明細日付","values": ["2024-12-06"]},{"code": "x002","label": "カスタム明細_コード","values": ["カスタムコード_入力内容B"]}]}] |
| 47 | 源泉徴収 | true/false | 源泉徴収の対象かどうか。 |
| 48 | 締日 | YYYY/MM/DD | 締日。 |
| 49 | 借方/貸方フラグ | 借方：S、貸方：H | 貸借区分。 |
| 49 | カスタム項目(明細)1 | 文字列の場合(最大255文字) | 文字列(最大255文字) |
| 49 | カスタム項目(明細)2 | 文字列の場合(最大255文字) | 文字列(最大255文字) |
| 49 | カスタム項目(明細)3 | 文字列の場合(最大255文字) | 文字列(最大255文字) |
・項目の出力順につきましては、「仕訳出力項目設定」で変更することができます。
・文字コードはShift_JISです。
6. その他の注意点
・仕訳のステータスが確定済みのレコードのみ出力されます。
・出力された仕訳レコードのステータスは出力済みに更新されます。
