請求データ取得API
1. 概要
受取側システムに取り込む請求データを取得する。
リクエストの取得データ区分によって、請求データ(未仕訳)、請求データ(仕訳済)、会計データのいずれかを取得する。
2. アクセス仕様
| 項目 | 内容 |
|---|---|
| プロトコル | HTTPS |
| メソッド | GET |
| ポート番号 | 443 |
| タイムアウト | 300秒 |
| URL | https://api.infomart.co.jp/v1/invoice/buyer/invdata |
| インターフェースバージョン | v1 |
3. リクエスト(HTTPS GET, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
| パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
|---|---|---|---|---|---|
| response_type | レスポンス形式 | 文字列 | 4 | ○ | "json" "xml" |
| reception_date_from | 受取日(From) | 文字列 | 10 | ○ | 「yyyy-MM-dd (JST)」の形式で指定する。 |
| reception_date_to | 受取日(To) | 文字列 | 10 | ○ | 「yyyy-MM-dd (JST)」の形式で指定する。 |
| final_approval_date_from | 最終経理承認日(From) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| final_approval_date_to | 最終経理承認日(To) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| pay_due_date_from | 支払期限(From) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| pay_due_date_to | 支払期限(To) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| close_date_from | 締日(From) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| close_date_to | 締日(To) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| payment_method | 支払方法 | 文字列 | 1 | 0:銀行振込 1:口座振替 2:現金 3:手形 4:クレジットカード 5:小切手 6:コンビニ決済 9:その他 |
|
| acc_code | 勘定科目コード | 文字列 | 15 | ||
| burden_sec_code | 負担部門コード | 文字列 | 15 | ||
| slip_date_from | 明細日付(From) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| slip_date_to | 明細日付(To) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| account_date_from | 会計伝票日付(From) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| account_date_to | 会計伝票日付(To) | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| extracting_type01 | 抽出種別(要対応) | 文字列 | 1 | 発行側企業より発行され、対応が必要な請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type02 | 抽出種別(新規) | 文字列 | 1 | 新規取引先の請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type03 | 抽出種別(差戻し) | 文字列 | 1 | ①社内承認フローの依頼が差戻しされた場合 ②経理承認フローの依頼が差戻しされた場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type04 | 抽出種別(未設定) | 文字列 | 1 | ①銀行振込で振込先口座が未選択の場合 ②未仕訳の場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type05 | 抽出種別(自社作成) | 文字列 | 1 | 自社作成の請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type06 | 抽出種別(自動取込) | 文字列 | 1 | 自動取込された請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type07 | 抽出種別(回答あり) | 文字列 | 1 | 質問回答のある請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type08 | 抽出種別(質問あり) | 文字列 | 1 | 質問のある請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type09 | 抽出種別(質問中) | 文字列 | 1 | 質問中の請求書を抽出するか。 0:未設定 1:抽出する |
|
| get_data_type | 取得データ区分 | 文字列 | 1 | ○ | 0:請求データ(未仕訳) 1:請求データ(仕訳済) 2:会計データ |
| invoice_type | 保存方式 | 文字列 | 1 | 0:請求書等保存方式 1:区分記載請求書等保存方式 |
|
| page_no | ページ番号 | 数字 | 4 | 何ページ目の請求データを取得するかを指定する。 1ページあたりの請求データ件数は100件ずつ取得する。 Ex) ページ番号1を指定された場合：1～100件目を取得 ページ番号2を指定された場合：101～200件目を取得 |
4. レスポンス (JSON/XML, UTF-8)
取得データ パターン表
取得データは、「請求書基本設定」の 会計ダウンロード>データ形式 の設定によって変わる。
各設定とリクエストによる取得パターンは以下の表を参照。
| パラメータ | ||||||
|---|---|---|---|---|---|---|
| 0：請求データ(未仕訳) | 1：請求データ(仕訳済) | 2：会計データ | ||||
| 集計・配賦仕訳機能を「使わない」 （明細データ） |
details[] | 明細情報のみ ※1 | details[] | 明細情報+仕訳 ※2 | details[] | 明細情報+仕訳 |
| jounals[] | × | jounals[] | × | jounals[] | × | |
| 集計・配賦仕訳機能を「使わない」 （集計データ） |
details[] | 明細情報のみ | details[] | 明細情報+仕訳 | details[] | 明細情報+仕訳 |
| jounals[] | × | jounals[] | ※3 | jounals[] | ※3 | |
| 集計・配賦仕訳機能を「使う」 集計・配賦を行っていない請求書 |
details[] | 明細情報のみ | details[] | 明細情報+仕訳 | details[] | 明細情報+仕訳 |
| jounals[] | × | jounals[] | × | jounals[] | × | |
| 集計・配賦仕訳機能を「使う」 集計・配賦を行った請求書 |
details[] | 明細情報のみ | details[] | 明細情報のみ | details[] | 明細情報のみ |
| jounals[] | × | jounals[] | ※4 | jounals[] | ※4 | |
※1 請求書の明細情報部分のみが連携される。
※2 請求書の明細情報と仕訳情報が連携される。
※3 『集計・配賦仕訳機能を「使わない」 （集計データ）』の場合の jounals[] は、会計項目をキーにして集計されたデータが連携される。
※4 『集計・配賦仕訳機能を「使う」 集計・配賦を行った請求書』の場合の jounals[] は、集計・配賦機能を使って作成したデータが連携される。
成功時
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | null固定。 | |
| invdata[] | 請求データ | 配列 | ○ | |
| invoice_mng_num | 請求書管理番号 | 数字 | ○ | |
| reception_date | 受取日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| final_approval_date | 最終経理承認日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| wf_status | ワークフローステータス | 文字列 | ○ | ワークフローを利用する場合 50:一次未承認 51:社内承認中 59:差戻受 60:経理承認中 69:経理差戻受 70:最終経理承認中 71:最終経理承認完了 ワークフローを利用しない場合 50:未処理 71:処理済 |
| processing_user_name | 処理中担当者名 | 文字列 | ||
| remind_date | 催促日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| order_date | 依頼日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| pay_due_date | 支払期限 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| private_cust_cd_s | 支払先コード | 文字列 | ||
| company_name_s | 支払先名 | 文字列 | ||
| company_name_kana_s | 支払先名カナ | 文字列 | ||
| private_cust_cd_b | 発行先コード | 文字列 | ||
| company_name_b | 発行先名 | 文字列 | ||
| company_name_kana_b | 発行先名カナ | 文字列 | ||
| destination_code | 宛先コード | 文字列 | ||
| destination_name | 宛先名 | 文字列 | ||
| inv_no | 請求書番号 | 文字列 | ||
| inv_name | 件名 | 文字列 | ||
| close_date | 締日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| send_date | 請求書発行日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| prev_inv_amount | 前回請求金額 | 数字 | マイナス記号が出力される場合もある。 | |
| payment | 入金額 | 数字 | マイナス記号が出力される場合もある。 | |
| adjustment | 調整金額 | 数字 | マイナス記号が出力される場合もある。 | |
| carryover_new | 繰越金額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax | 今回請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax | 今回消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount | 今回請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_show_amount | おもての請求金額 | 数字 | マイナス記号が出力される場合もある。 | |
| make_acc_flg | 明細配賦仕訳フラグ | 文字列 | 0:配賦仕訳なし 1:配賦仕訳あり |
|
| comp_inv_mng_num | ブロック管理番号 | 数字 | ||
| es_company_id_b | 買い手企業ID | 数字 | ||
| tax_rate_sec | 税率 | 数字 | 0:0% 5:5% 8:8% 10:10% |
|
| customer_mng_num | 取引先管理番号 | 数字 | ||
| contact | 問い合わせ先 | 文字列 | ||
| unit_tax_calc_sec | 課税単位 | 文字列 | ○ | 0:請求総額 1:明細単位 |
| private_input_flg | 作成方法 | 文字列 | ブランク:通常作成 0:外部連携 1:自社作成 |
|
| payment_method | 支払方法 | 文字列 | 0:銀行振込 1:口座振替 2:現金 3:手形 4:クレジットカード 5:小切手 6:コンビニ決済 9:その他 |
|
| invoice_mng_code | 請求書管理コード | 文字列 | ||
| invoice_title | 請求書タイトル | 文字列 | ||
| invoice_amount_title | 請求金額タイトル | 文字列 | ||
| customer_code1 | 顧客コード1 | 文字列 | ||
| customer_code2 | 顧客コード2 | 文字列 | ||
| remarks | おもて備考 | 文字列 | ||
| acc_memo | 会計ダウンロード用メモ | 文字列 | ||
| inv_free_txt1 | おもての自由項目1（文字） | 文字列 | ||
| inv_free_txt2 | おもての自由項目2（文字） | 文字列 | ||
| inv_free_txt3 | おもての自由項目3（文字） | 文字列 | ||
| inv_free_num1 | おもての自由項目1（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num2 | おもての自由項目2（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num3 | おもての自由項目3（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num4 | おもての自由項目4（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num5 | おもての自由項目5（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num6 | おもての自由項目6（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_free_num7 | おもての自由項目7（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| inv_op_free_txt1 | 追加自由項目1（文字） | 文字列 | ||
| inv_op_free_txt2 | 追加自由項目2（文字） | 文字列 | ||
| inv_op_free_txt3 | 追加自由項目3（文字） | 文字列 | ||
| inv_op_free_txt4 | 追加自由項目4（文字） | 文字列 | ||
| inv_op_free_txt5 | 追加自由項目5（文字） | 文字列 | ||
| inv_op_free_txt6 | 追加自由項目6（文字） | 文字列 | ||
| inv_op_free_txt7 | 追加自由項目7（文字） | 文字列 | ||
| inv_op_free_txt8 | 追加自由項目8（文字） | 文字列 | ||
| inv_op_free_txt9 | 追加自由項目9（文字） | 文字列 | ||
| inv_op_free_txt10 | 追加自由項目10（文字） | 文字列 | ||
| inv_op_free_txt11 | 追加自由項目11（文字） | 文字列 | ||
| inv_op_free_txt12 | 追加自由項目12（文字） | 文字列 | ||
| invoice_type | 保存方式 | 文字列 | ○ | 0:請求書等保存方式 1:区分記載請求書等保存方式 |
| inv_without_tax_tr10 | 10%請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_tr10 | 10%消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_tr10 | 10%請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_tr8_reduced | 軽減8%請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_tr8_reduced | 軽減8%消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_tr8_reduced | 軽減8%請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_tr8 | 8%請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_tr8 | 8%消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_tr8 | 8%請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_tr5 | 5%請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_tr5 | 5%消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_tr5 | 5%請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_tr0 | 0%請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_tr0 | 0%消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_tr0 | 0%請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_free | 非課税請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_free | 非課税消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_free | 非課税請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_exemption | 免税請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_exemption | 免税消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_exemption | 免税請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax_non | 不課税請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax_non | 不課税消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount_non | 不課税請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| additional_flg | 追記フラグ | 文字列 | 0:追記なし 1:受取側で追記 |
|
| invoice_url | 請求書URL | 文字列 | ||
| publisher | 発行元 | オブジェクト | ||
| publisher_company_name | 事業所・営業所名 | 文字列 | ||
| publisher_section | 部署 | 文字列 | ||
| publisher_zip | 郵便番号 | 文字列 | 「XXX-XXXX」の形式で出力する。 | |
| publisher_address1 | 住所 | 文字列 | ||
| publisher_address2 | 住所（番地、建物名） | 文字列 | ||
| publisher_phone | 電話番号 | 文字列 | 「XXXXX-XXXX-XXXX」の形式で出力する。 | |
| banks[] | 振込先口座情報 | 配列 | 支払方法が「0:銀行振込」ではない場合、null固定。 | |
| transfer_code | 振込先コード | 文字列 | ||
| fncl_inst_code | 金融機関コード | 文字列 | ||
| fncl_inst_name | 金融機関名 | 文字列 | ||
| fncl_inst_kana | 金融機関名カナ | 文字列 | ||
| branch_code | 支店コード | 文字列 | ||
| branch_name | 支店名 | 文字列 | ||
| branch_kana | 支店名カナ | 文字列 | ||
| deposit_sec | 預金種別 | 文字列 | 1:普通預金 2:当座預金 4:貯蓄預金 9:その他 |
|
| account_num | 口座番号 | 文字列 | ||
| depositor_name | 預金者名 | 文字列 | ||
| depositor_kana | 預金者名カナ | 文字列 | ||
| select_bank_flg | 口座選択フラグ | 文字列 | 0:未選択 1:選択 |
|
| details[] | 明細 | 配列 | ||
| detail_seq | 明細連番 | 数字 | ○ | |
| item_slip_no | 明細番号 | 文字列 | ||
| item_slip_date | 明細日付 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| item_prod_code | 商品コード | 文字列 | ||
| item_name | 品目・摘要 | 文字列 | ||
| item_qty | 数量 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_price | 単価 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_unit | 単位 | 文字列 | ||
| item_without_tax | 金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_tax | 消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_amount | 請求金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_sec_code | 部門コード | 文字列 | ||
| item_sec_name | 部門名 | 文字列 | ||
| account_date | 会計処理日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| tax_free | 税区分 | 文字列 | 0:課税 1:非課税 2:免税 3:不課税 ※保存方式が「請求書等保存方式」で、かつ課税単位が「請求総額」の場合は設定されない。 |
|
| tax_rate | 税率 | 数字 | 0:0% 5:5% 8:8% 10:10% ※保存方式が「請求書等保存方式」で、かつ課税単位が「請求総額」の場合は設定されない。 ※保存方式が「請求書等保存方式」で、かつ税区分指定が「指定しない」で、かつ課税単位が「明細単位」の場合は設定されない。 |
|
| reduced_tax_flg | 軽減税率フラグ | 文字列 | ○ | 0:軽減税率対象外 1:軽減税率対象 |
| journal_exempt_flg | 仕訳対象外フラグ | 文字列 | ○ | 0:仕訳対象 1:仕訳対象外 |
| burden_sec_code_d | 借方負担部門コード | 文字列 | ||
| burden_sec_name_d | 借方負担部門名 | 文字列 | ||
| acc_code_d | 借方勘定科目コード | 文字列 | ||
| acc_name_d | 借方勘定科目名 | 文字列 | ||
| acc_spcrs_code_d | 借方補助科目コード | 文字列 | ||
| acc_spcrs_name_d | 借方補助科目名 | 文字列 | ||
| item_aut_amount_d | 借方税込金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_aut_tax_d | 借方消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_without_tax_d | 借方税抜金額 | 数字 | マイナス記号が出力される場合もある。 | |
| burden_sec_code_c | 貸方負担部門コード | 文字列 | ||
| burden_sec_name_c | 貸方負担部門名 | 文字列 | ||
| acc_code_c | 貸方勘定科目コード | 文字列 | ||
| acc_name_c | 貸方勘定科目名 | 文字列 | ||
| acc_spcrs_code_c | 貸方補助科目コード | 文字列 | ||
| acc_spcrs_name_c | 貸方補助科目名 | 文字列 | ||
| item_aut_amount_c | 貸方税込金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_aut_tax_c | 貸方消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_without_tax_c | 貸方税抜金額 | 数字 | マイナス記号が出力される場合もある。 | |
| jnl_spcrs_code1 | 仕訳補助項目コード１ | 文字列 | ||
| jnl_spcrs_name1 | 仕訳補助項目名称１ | 文字列 | ||
| jnl_spcrs_code2 | 仕訳補助項目コード２ | 文字列 | ||
| jnl_spcrs_name2 | 仕訳補助項目名称２ | 文字列 | ||
| jnl_spcrs_code3 | 仕訳補助項目コード３ | 文字列 | ||
| jnl_spcrs_name3 | 仕訳補助項目名称３ | 文字列 | ||
| jnl_spcrs_code4 | 仕訳補助項目コード４ | 文字列 | ||
| jnl_spcrs_name4 | 仕訳補助項目名称４ | 文字列 | ||
| jnl_spcrs_code5 | 仕訳補助項目コード５ | 文字列 | ||
| jnl_spcrs_name5 | 仕訳補助項目名称５ | 文字列 | ||
| jnl_spcrs_code6 | 仕訳補助項目コード６ | 文字列 | ||
| jnl_spcrs_name6 | 仕訳補助項目名称６ | 文字列 | ||
| jnl_spcrs_code7 | 仕訳補助項目コード７ | 文字列 | ||
| jnl_spcrs_name7 | 仕訳補助項目名称７ | 文字列 | ||
| jnl_spcrs_code8 | 仕訳補助項目コード８ | 文字列 | ||
| jnl_spcrs_name8 | 仕訳補助項目名称８ | 文字列 | ||
| jnl_free_txt9 | 仕訳自由項目９ | 文字列 | ||
| jnl_free_txt10 | 仕訳自由項目１０ | 文字列 | ||
| jnl_free_txt11 | 仕訳自由項目１１ | 文字列 | ||
| jnl_free_txt12 | 仕訳自由項目１２ | 文字列 | ||
| detail_summary | 明細摘要 | 文字列 | ||
| detail_remarks | 明細備考 | 文字列 | ||
| item_memo1 | 明細メモ項目１ | 文字列 | ||
| item_memo2 | 明細メモ項目２ | 文字列 | ||
| item_free_txt1 | 明細の自由項目1（文字） | 文字列 | ||
| item_free_txt2 | 明細の自由項目2（文字） | 文字列 | ||
| item_free_txt3 | 明細の自由項目3（文字） | 文字列 | ||
| item_free_txt4 | 明細の自由項目4（文字） | 文字列 | ||
| item_free_txt5 | 明細の自由項目5（文字） | 文字列 | ||
| item_free_txt6 | 明細の自由項目6（文字） | 文字列 | ||
| item_free_txt7 | 明細の自由項目7（文字） | 文字列 | ||
| item_free_txt8 | 明細の自由項目8（文字） | 文字列 | ||
| item_free_txt9 | 明細の自由項目9（文字） | 文字列 | ||
| item_free_txt10 | 明細の自由項目10（文字） | 文字列 | ||
| item_free_txt_l | 明細の自由項目11（文字） | 文字列 | ||
| custom_header | カスタムヘッダー情報 | オブジェクト | ||
| custom_name | カスタム名 | 文字列 | ||
| custom_detail_headers[] | カスタム明細ヘッダー情報 | 配列 | 返却される要素数は9件まで。 | |
| field_seq | 項目連番 | 数字 | 1～9の連番で返却される。 カスタム明細データ情報.項目連番とリンクする。 |
|
| field_name | 項目名 | 文字列 | ||
| field_type | データ型 | 文字列 | "S":文字列 "N":数字 |
|
| field_num_decimal_places | 小数点以下桁数 | 数字 | データ型が"N"の場合、0～3。 データ型が"S"の場合、null。 |
|
| field_col_width | 列幅 | 数字 | 1～100（単位:%） | |
| custom_details[] | カスタム明細情報 | 配列 | ||
| custom_detail_values[] | カスタム明細データ情報 | 配列 | 返却される要素数は9件まで。 | |
| field_seq | 項目連番 | 数字 | 1～9の連番で返却される。 カスタム明細ヘッダー情報.項目連番とリンクする。 |
|
| field_value | データ値 | ※ | ※ ①カスタム明細ヘッダー情報.データ型が"S"の場合 型:文字列 ②カスタム明細ヘッダー情報.データ型が"N"の場合 型:数字 |
|
| jounals[] | 仕訳 | 配列 | ||
| jounal_seq | 仕訳連番 | 数字 | ○ | |
| account_date | 会計処理日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| tax_free | 税区分 | 文字列 | 0:課税 1:非課税 2:免税 3:不課税 |
|
| tax_rate | 税率 | 数字 | 0:0% 5:5% 8:8% 10:10% |
|
| reduced_tax_flg | 軽減税率フラグ | 文字列 | 0:軽減税率対象外 1:軽減税率対象 |
|
| burden_sec_code_d | 借方負担部門コード | 文字列 | ||
| burden_sec_name_d | 借方負担部門名 | 文字列 | ||
| acc_code_d | 借方勘定科目コード | 文字列 | ||
| acc_name_d | 借方勘定科目名 | 文字列 | ||
| acc_spcrs_code_d | 借方補助科目コード | 文字列 | ||
| acc_spcrs_name_d | 借方補助科目名 | 文字列 | ||
| item_aut_amount_d | 借方税込金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_aut_tax_d | 借方消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_without_tax_d | 借方税抜金額 | 数字 | マイナス記号が出力される場合もある。 | |
| burden_sec_code_c | 貸方負担部門コード | 文字列 | ||
| burden_sec_name_c | 貸方負担部門名 | 文字列 | ||
| acc_code_c | 貸方勘定科目コード | 文字列 | ||
| acc_name_c | 貸方勘定科目名 | 文字列 | ||
| acc_spcrs_code_c | 貸方補助科目コード | 文字列 | ||
| acc_spcrs_name_c | 貸方補助科目名 | 文字列 | ||
| item_aut_amount_c | 貸方税込金額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_aut_tax_c | 貸方消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| item_without_tax_c | 貸方税抜金額 | 数字 | マイナス記号が出力される場合もある。 | |
| jnl_spcrs_code1 | 仕訳補助項目コード１ | 文字列 | ||
| jnl_spcrs_name1 | 仕訳補助項目名称１ | 文字列 | ||
| jnl_spcrs_code2 | 仕訳補助項目コード２ | 文字列 | ||
| jnl_spcrs_name2 | 仕訳補助項目名称２ | 文字列 | ||
| jnl_spcrs_code3 | 仕訳補助項目コード３ | 文字列 | ||
| jnl_spcrs_name3 | 仕訳補助項目名称３ | 文字列 | ||
| jnl_spcrs_code4 | 仕訳補助項目コード４ | 文字列 | ||
| jnl_spcrs_name4 | 仕訳補助項目名称４ | 文字列 | ||
| jnl_spcrs_code5 | 仕訳補助項目コード５ | 文字列 | ||
| jnl_spcrs_name5 | 仕訳補助項目名称５ | 文字列 | ||
| jnl_spcrs_code6 | 仕訳補助項目コード６ | 文字列 | ||
| jnl_spcrs_name6 | 仕訳補助項目名称６ | 文字列 | ||
| jnl_spcrs_code7 | 仕訳補助項目コード７ | 文字列 | ||
| jnl_spcrs_name7 | 仕訳補助項目名称７ | 文字列 | ||
| jnl_spcrs_code8 | 仕訳補助項目コード８ | 文字列 | ||
| jnl_spcrs_name8 | 仕訳補助項目名称８ | 文字列 | ||
| jnl_free_txt9 | 仕訳自由項目９ | 文字列 | ||
| jnl_free_txt10 | 仕訳自由項目１０ | 文字列 | ||
| jnl_free_txt11 | 仕訳自由項目１１ | 文字列 | ||
| jnl_free_txt12 | 仕訳自由項目１２ | 文字列 | ||
| jnl_summary | 仕訳摘要 | 文字列 | ||
| inv_free_titles | 請求書自由項目タイトル | オブジェクト | ||
| inv_free_txt_title1 | おもての自由項目1（文字）タイトル | 文字列 | ||
| inv_free_txt_title2 | おもての自由項目2（文字）タイトル | 文字列 | ||
| inv_free_txt_title3 | おもての自由項目3（文字）タイトル | 文字列 | ||
| inv_free_num_title1 | おもての自由項目1（数値）タイトル | 文字列 | ||
| inv_free_num_title2 | おもての自由項目2（数値）タイトル | 文字列 | ||
| inv_free_num_title3 | おもての自由項目3（数値）タイトル | 文字列 | ||
| inv_free_num_title4 | おもての自由項目4（数値）タイトル | 文字列 | ||
| inv_free_num_title5 | おもての自由項目5（数値）タイトル | 文字列 | ||
| inv_free_num_title6 | おもての自由項目6（数値）タイトル | 文字列 | ||
| inv_free_num_title7 | おもての自由項目7（数値）タイトル | 文字列 | ||
| inv_op_free_txt_title1 | 追加自由項目（文字）タイトル1 | 文字列 | ||
| inv_op_free_txt_title2 | 追加自由項目（文字）タイトル2 | 文字列 | ||
| inv_op_free_txt_title3 | 追加自由項目（文字）タイトル3 | 文字列 | ||
| inv_op_free_txt_title4 | 追加自由項目（文字）タイトル4 | 文字列 | ||
| inv_op_free_txt_title5 | 追加自由項目（文字）タイトル5 | 文字列 | ||
| inv_op_free_txt_title6 | 追加自由項目（文字）タイトル6 | 文字列 | ||
| inv_op_free_txt_title7 | 追加自由項目（文字）タイトル7 | 文字列 | ||
| inv_op_free_txt_title8 | 追加自由項目（文字）タイトル8 | 文字列 | ||
| inv_op_free_txt_title9 | 追加自由項目（文字）タイトル9 | 文字列 | ||
| inv_op_free_txt_title10 | 追加自由項目（文字）タイトル10 | 文字列 | ||
| inv_op_free_txt_title11 | 追加自由項目（文字）タイトル11 | 文字列 | ||
| inv_op_free_txt_title12 | 追加自由項目（文字）タイトル12 | 文字列 | ||
| item_free_txt_title1 | 明細の自由項目1（文字）タイトル | 文字列 | ||
| item_free_txt_title2 | 明細の自由項目2（文字）タイトル | 文字列 | ||
| item_free_txt_title3 | 明細の自由項目3（文字）タイトル | 文字列 | ||
| item_free_txt_title4 | 明細の自由項目4（文字）タイトル | 文字列 | ||
| item_free_txt_title5 | 明細の自由項目5（文字）タイトル | 文字列 | ||
| item_free_txt_title6 | 明細の自由項目6（文字）タイトル | 文字列 | ||
| item_free_txt_title7 | 明細の自由項目7（文字）タイトル | 文字列 | ||
| item_free_txt_title8 | 明細の自由項目8（文字）タイトル | 文字列 | ||
| item_free_txt_title9 | 明細の自由項目9（文字）タイトル | 文字列 | ||
| item_free_txt_title10 | 明細の自由項目10（文字）タイトル | 文字列 | ||
| item_free_txt_l_title | 明細の自由項目11（文字）タイトル | 文字列 | ||
| jounal_frees | 仕訳自由項目 | オブジェクト | ||
| jnl_free_code1 | 仕訳自由項目コード１ | 文字列 | ||
| jnl_free_name1 | 仕訳自由項目名称１ | 文字列 | ||
| jnl_free_code2 | 仕訳自由項目コード２ | 文字列 | ||
| jnl_free_name2 | 仕訳自由項目名称２ | 文字列 | ||
| jnl_free_code3 | 仕訳自由項目コード３ | 文字列 | ||
| jnl_free_name3 | 仕訳自由項目名称３ | 文字列 | ||
| jnl_free_code4 | 仕訳自由項目コード４ | 文字列 | ||
| jnl_free_name4 | 仕訳自由項目名称４ | 文字列 | ||
| jnl_free_code5 | 仕訳自由項目コード５ | 文字列 | ||
| jnl_free_name5 | 仕訳自由項目名称５ | 文字列 | ||
| jnl_free_code6 | 仕訳自由項目コード６ | 文字列 | ||
| jnl_free_name6 | 仕訳自由項目名称６ | 文字列 | ||
| jnl_free_code7 | 仕訳自由項目コード７ | 文字列 | ||
| jnl_free_name7 | 仕訳自由項目名称７ | 文字列 | ||
| jnl_free_code8 | 仕訳自由項目コード８ | 文字列 | ||
| jnl_free_name8 | 仕訳自由項目名称８ | 文字列 | ||
| jnl_free_code9 | 仕訳自由項目コード９ | 文字列 | ||
| jnl_free_name9 | 仕訳自由項目名称９ | 文字列 | ||
| jnl_free_code10 | 仕訳自由項目コード１０ | 文字列 | ||
| jnl_free_name10 | 仕訳自由項目名称１０ | 文字列 | ||
| jnl_free_code11 | 仕訳自由項目コード１１ | 文字列 | ||
| jnl_free_name11 | 仕訳自由項目名称１１ | 文字列 | ||
| jnl_free_code12 | 仕訳自由項目コード１２ | 文字列 | ||
| jnl_free_name12 | 仕訳自由項目名称１２ | 文字列 |
失敗時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | ○ | |
| error_item | エラー項目 | 文字列 | ||
| error_code | エラーコード | 文字列 | ○ | |
| error_detail | エラー内容 | 文字列 | ○ | |
| invdata[] | 請求データ | 配列 | null固定。 | |
| jounal_frees | 仕訳自由項目 | オブジェクト | null固定。 |
5. 処理詳細
5.1. API実行権限チェック
API利用ユーザーが有料会員かチェックを行う。
受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。
5.2. リクエストチェック
リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。
5.3. 請求データの取得処理
リクエストに該当する請求データを取得する。
5.4. 仕訳自由項目の取得処理
リクエストに該当する仕訳自由項目を取得する。
5.5. 取得結果送信
取得した請求データと仕訳自由項目をJSON/XML形式で返却する。
6. 備考・補足
特になし。
