仕訳関連マスタ登録API
1. 概要
仕訳関連のマスタ（勘定科目、勘定補助科目、負担部門、仕訳補助項目）の登録・更新・削除を行う。
2. アクセス仕様
| 項目 | 内容 |
|---|---|
| プロトコル | HTTPS |
| メソッド | POST |
| ポート番号 | 443 |
| タイムアウト | 300秒 |
| URL | https://api.infomart.co.jp/v1/invoice/buyer/journal_masters |
| インターフェースバージョン | v1 |
3. リクエスト(JSON/XML, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
| パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
|---|---|---|---|---|---|
| response_type | レスポンス形式 | 文字列 | 4 |
○ | "json" "xml" |
| acc[] | 勘定科目 | 配列 | - |
△ | 勘定科目、負担部門、仕訳補助項目のいずれか一項目以上は必須。 |
| acc_code | 勘定科目コード | 文字列 | 15 |
△ | 勘定科目名、勘定科目削除フラグ、勘定補助科目コード、勘定補助科目名、勘定補助科目削除フラグのいずれかが入力時は必須。 |
| acc_name | 勘定科目名 | 文字列 | 30 |
△ | 勘定科目削除フラグが「0:削除しない」の場合は必須。 |
| acc_del_flg | 勘定科目削除フラグ | 文字列 | 1 |
対象の勘定科目とその配下の勘定補助科目を削除するか否かを設定する。 0:未設定 1:削除する |
|
| acc_spcrs[] | 勘定補助科目 | 配列 | - |
||
| acc_spcrs_code | 勘定補助科目コード | 文字列 | 15 |
△ | 勘定補助科目名、勘定補助科目削除フラグのいずれかが入力時は必須。 |
| acc_spcrs_name | 勘定補助科目名 | 文字列 | 30 |
△ | 勘定補助科目削除フラグが「0:削除しない」の場合は必須。 |
| acc_spcrs_del_flg | 補助科目削除フラグ | 文字列 | 1 |
対象の勘定補助科目を削除するか否かを設定する。 0:未設定 1:削除する |
|
| burden_sectors[] | 負担部門 | 配列 | - |
△ | 勘定科目、負担部門、仕訳補助項目のいずれか一項目以上は必須。 |
| burden_sec_code | 負担部門コード | 文字列 | 15 |
△ | 負担部門名、負担部門削除フラグのいずれかが入力時は必須。 |
| burden_sec_name | 負担部門名 | 文字列 | 500 |
△ | 負担部門削除フラグが「0:削除しない」の場合は必須。 |
| burden_sec_del_flg | 負担部門削除フラグ | 文字列 | 1 |
対象の負担部門を削除するか否かを設定する。 0:未設定 1:削除する |
|
| jnl_spcrs[] | 仕訳補助項目 | 配列 | - |
△ | 勘定科目、負担部門、仕訳補助項目のいずれか一項目以上は必須。 |
| jnl_spcrs_code | 仕訳補助項目コード | 文字列 | 15 |
△ | 仕訳補助項目名、仕訳自由項目表示番号、仕訳補助項目削除フラグのいずれかが入力時は必須。 |
| jnl_spcrs_name | 仕訳補助項目名 | 文字列 | 30 |
△ | 仕訳補助項目削除フラグが「0:削除しない」の場合は必須。 |
| jnl_free_disp_num | 仕訳自由項目表示番号 | 文字列 | 1 |
△ | 仕訳補助項目削除フラグが「0:削除しない」の場合は必須。 1〜8固定。 |
| jnl_spcrs_del_flg | 仕訳補助項目削除フラグ | 文字列 | 1 |
対象の仕訳補助項目を削除するか否かを設定する。 0:未設定 1:削除する |
4. レスポンス (JSON/XML, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
成功時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | null固定。 |
失敗時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | ○ | |
| error_item | エラー項目 | 文字列 | ||
| error_code | エラーコード | 文字列 | ○ | |
| error_detail | エラー内容 | 文字列 | ○ |
5. 処理詳細
5.1. API実行権限チェック
API利用ユーザーが有料会員かチェックを行う。
受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。
5.2. リクエストチェック
リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。
5.3. 勘定科目と勘定補助科目の登録・更新・削除処理
リクエストで指定された勘定科目と勘定補助科目の登録・更新・削除を行う。
①勘定科目削除フラグが空または「0:未設定」でかつ勘定科目が未登録の場合、指定された勘定科目を登録する。
②勘定科目削除フラグが空または「0:未設定」でかつ勘定科目が登録済の場合、指定された勘定科目を更新する。
③勘定科目削除フラグが「1:削除する」の場合、指定された勘定科目と配下のすべての勘定補助科目を削除する。
④勘定補助科目削除フラグが空または「0:未設定」でかつ勘定補助科目が未登録の場合、指定された勘定補助科目を登録する。
⑤勘定補助科目削除フラグが空または「0:未設定」でかつ勘定補助科目が登録済の場合、指定された勘定補助科目を更新する。
⑥勘定補助科目削除フラグが「1:削除する」の場合、指定された勘定補助科目を削除する。
5.4. 負担部門の登録・更新・削除処理
リクエストで指定された負担部門の登録・更新・削除を行う。
①負担部門削除フラグが空または「0:未設定」でかつ負担部門が未登録の場合、指定された負担部門を登録する。
②負担部門削除フラグが空または「0:未設定」でかつ負担部門が登録済の場合、指定された負担部門を更新する。
③負担部門削除フラグが「1:削除する」の場合、指定された負担部門を削除する。
5.5. 仕訳補助項目の登録・更新・削除処理
リクエストで指定された仕訳補助項目の登録・更新・削除を行う。
①仕訳補助項目削除フラグが空または「0:未設定」でかつ仕訳補助項目が未登録の場合、指定された仕訳補助項目を登録する。
②仕訳補助項目削除フラグが空または「0:未設定」でかつ仕訳補助項目が登録済の場合、指定された仕訳補助項目を更新する。
③仕訳補助項目削除フラグが「1:削除する」の場合、指定された仕訳補助項目を削除する。
5.6. 処理結果送信
処理結果をJSON/XML形式で返却する。
6. 備考・補足
特になし。
