Info Mart Corporation 株式会社インフォマート

仕訳関連マスタ取得API

1. 概要

登録済の仕訳関連のマスタ(勘定科目、勘定補助科目、負担部門、仕訳補助項目)を取得する。

2. アクセス仕様

項目 内容
プロトコル HTTPS
メソッド GET
ポート番号 443
タイムアウト 300秒
URL https://api.infomart.co.jp/v1/invoice/buyer/journal_masters
インターフェースバージョン v1

3. リクエスト(HTTPS GET, UTF-8)

※必須項目の○は必須、△は条件付き必須となる(条件は備考を参照)

パラメータ名 名前 長さ・範囲 必須 備考
response_type レスポンス形式 文字列 4 "json"
"xml"
acc_code 勘定科目コード 文字列 15   ①未指定の場合、すべての勘定科目とそれに紐づく勘定補助科目を取得する。
②指定された場合、指定されたコードを含む勘定科目とそれに紐づく勘定補助科目を取得する。
burden_sec_code 負担部門コード 文字列 15   ①未指定の場合、すべての負担部門を取得する。
②指定された場合、指定されたコードを含む負担部門を取得する。
jnl_spcrs_code 仕訳補助項目コード 文字列 15   ①未指定の場合、すべての仕訳補助項目を取得する。
②指定された場合、指定されたコードを含む仕訳補助項目を取得する。

4. レスポンス (JSON/XML, UTF-8)

※必須項目の○は必須、△は条件付き必須となる(条件は備考を参照)

成功時

要素名・階層 要素内容 必須 備考
result 処理結果 文字列  
error_list[] エラーリスト 配列   null固定。
acc[] 勘定科目 配列    
   acc_code 勘定科目コード 文字列    
   acc_name 勘定科目名 文字列    
   acc_spcrs[] 勘定補助科目 配列    
      acc_spcrs_code 勘定補助科目コード 文字列    
      acc_spcrs_name 勘定補助科目名 文字列    
burden_sectors[] 負担部門 配列    
   burden_sec_code 負担部門コード 文字列    
   burden_sec_name 負担部門名 文字列    
jnl_spcrs[] 仕訳補助項目 配列   仕訳自由項目のオプション設定がない場合はnull固定。
   jnl_spcrs_code 仕訳補助項目コード 文字列    
   jnl_spcrs_name 仕訳補助項目名 文字列    
   jnl_free_disp_num 仕訳自由項目表示番号 文字列   1〜8固定。

失敗時

要素名・階層 要素内容 必須 備考
result 処理結果 文字列  
error_list[] エラーリスト 配列  
   error_item エラー項目 文字列    
   error_code エラーコード 文字列  
   error_detail エラー内容 文字列  
acc[] 勘定科目 配列   null固定。
burden_sectors[] 負担部門 配列   null固定。
jnl_spcrs[] 仕訳補助項目 配列   null固定。

5. 処理詳細

5.1. API実行権限チェック

API利用ユーザーが有料会員かチェックを行う。
受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。

5.2. リクエストチェック

リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。

5.3. 勘定科目と勘定補助科目の取得処理

リクエストに該当する勘定科目とその配下の勘定補助科目を取得する。

5.4. 負担部門の取得処理

リクエストに該当する負担部門を取得する。

5.5. 仕訳補助項目の取得処理

リクエストに該当する仕訳補助項目を取得する。

5.6. 取得結果送信

取得した勘定科目、勘定補助科目、負担部門、仕訳補助項目をJSON/XML形式で返却する。

6. 備考・補足

特になし。