請求書一覧取得API
1. 概要
請求書を一覧取得する。
2. アクセス仕様
| 項目 | 内容 |
|---|---|
| プロトコル | HTTPS |
| メソッド | GET |
| ポート番号 | 443 |
| タイムアウト | 300秒 |
| URL | https://api.infomart.co.jp/v1/invoice/seller/invoices |
| インターフェースバージョン | v1 |
3. リクエスト(HTTPS GET, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
| パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
|---|---|---|---|---|---|
| response_type | レスポンス形式 | 文字列 | 4 | ○ | "json" "xml" |
| target | 抽出対象 | 文字列 | 1 | ○ | 1:発行済み 2:承認依頼中 3:あなたの未処理 4:あなたの未処理（発行承認） 5:メンバーの未処理 |
| target_date_from | 抽出対象日（From） | 文字列 | 10 | ○ | 「yyyy-MM-dd (JST)」の形式で指定する。 抽出対象によって以下の項目を検索する。 「1:発行済み」の場合:発行日 「2:承認依頼中」の場合:依頼日 「3:あなたの未処理」の場合:受取日 「4:あなたの未処理（発行承認）」の場合:受取日 |
| target_date_to | 抽出対象日（To） | 文字列 | 10 | ○ | 「yyyy-MM-dd (JST)」の形式で指定する。 抽出対象によって以下の項目を検索する。 「1:発行済み」の場合:発行日 「2:承認依頼中」の場合:依頼日 「3:あなたの未処理」の場合:受取日 「4:あなたの未処理（発行承認）」の場合:受取日 |
| private_cust_cd | 発行先コード | 文字列 | 15 | ||
| close_date | 締日 | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| seal_flg | 発行先確認状況 | 文字列 | 1 | 0:未確認 1:確認済み |
|
| private_user_employee_no | 自社担当者社員コード | 文字列 | 15 | ||
| extracting_type01 | 抽出種別(再発行) | 文字列 | 1 | 再発行された請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type02 | 抽出種別(新規) | 文字列 | 1 | 新規取引先の請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type03 | 抽出種別(差戻し) | 文字列 | 1 | ①社内承認フローの依頼が差戻しされた場合 ②発行承認の依頼が差戻しされた場合 ③受取側企業より差戻しされた場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type04 | 抽出種別(削除) | 文字列 | 1 | 削除された請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type05 | 抽出種別(FAXエラー) | 文字列 | 1 | FAX送信エラーとなった請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type06 | 抽出種別(質問歴あり) | 文字列 | 1 | 質問歴のある請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type07 | 抽出種別(未催促) | 文字列 | 1 | 未催促の請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type08 | 抽出種別(依頼取消) | 文字列 | 1 | ①社内承認フローの依頼が取消された場合 ②発行承認の依頼が取消された場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type09 | 抽出種別(承認依頼) | 文字列 | 1 | ①社内承認フローの依頼がある場合 ②発行承認の依頼がある場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type10 | 抽出種別(質問あり) | 文字列 | 1 | 質問のある請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type11 | 抽出種別(FAX送信あり) | 文字列 | 1 | FAX送信された請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type12 | 抽出種別(再依頼) | 文字列 | 1 | ①社内承認フローの再依頼がある場合 ②発行承認の再依頼がある場合 上記のいずれかの請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type13 | 抽出種別(回答あり) | 文字列 | 1 | 質問回答のある請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type14 | 抽出種別(発行予約中) | 文字列 | 1 | 発行予約中の請求書を抽出するか。 0:未設定 1:抽出する |
|
| extracting_type15 | 抽出種別(発行済削除) | 文字列 | 1 | 発行済削除の請求書を抽出するか。 0:未設定 1:抽出する |
|
| external_data_flg | 外部連携フラグ | 文字列 | 1 | 0:外部連携以外 2:API作成 |
4. レスポンス (JSON/XML, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
成功時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | null固定。 | |
| invoices[] | 請求書 | 配列 | ||
| invoice_mng_num | 請求書管理番号 | 数字 | ||
| publisher | 発行元 | オブジェクト | ||
| publisher_mng_num | 発行元コード | 文字列 | ||
| publisher_company_name | 事業所・営業所名 | 文字列 | ||
| publisher_section | 部署 | 文字列 | ||
| publisher_zip | 郵便番号 | 文字列 | 「XXX-XXXX」の形式で出力する。 | |
| publisher_address1 | 住所 | 文字列 | ||
| publisher_address2 | 住所（番地、建物名） | 文字列 | ||
| publisher_phone | 電話番号 | 文字列 | 「XXXXX-XXXX-XXXX」の形式で出力する。 | |
| invoice_setting_code | 請求書書式設定コード | 文字列 | ||
| inv_no | 請求書番号 | 文字列 | ||
| private_cust_cd | 発行先コード | 文字列 | ○ | |
| invoice_title | 請求書タイトル | 文字列 | ||
| inv_name | 件名 | 文字列 | ||
| pay_due_date | 入金期限 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| payment_method | 入金方法 | 文字列 | 0:銀行振込 1:口座振替 2:現金 3:手形 4:クレジットカード 5:小切手 6:コンビニ決済 9:その他 |
|
| prev_inv_amount | 前回請求金額 | 数字 | マイナス記号が出力される場合もある。 | |
| payment | 入金額 | 数字 | マイナス記号が出力される場合もある。 | |
| adjustment | 調整金額 | 数字 | マイナス記号が出力される場合もある。 | |
| carryover_new | 繰越金額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_without_tax | 今回請求金額（税抜） | 数字 | マイナス記号が出力される場合もある。 | |
| inv_tax | 今回消費税額 | 数字 | マイナス記号が出力される場合もある。 | |
| inv_amount | 今回請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| invoice_amount_title | 請求金額タイトル | 文字列 | ||
| inv_show_amount | おもての請求金額 | 数字 | ○ | マイナス記号が出力される場合もある。 |
| close_date | 締日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| remarks | 備考 | 文字列 | ||
| customer_code1 | 顧客コード1 | 文字列 | ||
| customer_code2 | 顧客コード2 | 文字列 | ||
| edi_info | EDI情報 | 文字列 | ||
| contact | 担当 | 文字列 | ||
| 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（数値） | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| unit_tax_calc_sec | 課税単位 | 文字列 | 0:請求総額 1:明細単位 |
|
| inv_coop_post_use_type | 請求書郵送代行サービス利用区分 | 文字列 | 0:発行先マスタ・お申し込み時の設定を適用する。 1:郵送代行を利用しない 2:郵送代行を利用する ※郵送代行オプションを利用していない場合は設定されない。 |
|
| private_print_flg | 自社印刷指定フラグ | 文字列 | 0:指定なし 1:指定あり |
|
| 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 | 不課税請求金額（税込） | 数字 | マイナス記号が出力される場合もある。 | |
| details[] | 明細情報 | 配列 | ||
| item_slip_date | 明細日付 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で指定する。 | |
| item_slip_no | 明細番号 | 文字列 | ||
| item_prod_code | 商品コード | 文字列 | ||
| item_name | 明細項目 | 文字列 | ||
| item_qty | 数量 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_price | 単価 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_unit | 単位 | 文字列 | ||
| item_without_tax | 金額 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_tax | 消費税額 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_amount | 請求金額 | 数字 | マイナス記号、小数点が出力される場合もある。 | |
| item_sec_code | 部門コード | 文字列 | ||
| item_sec_name | 部門名 | 文字列 | ||
| detail_remarks | 備考 | 文字列 | ||
| 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（文字） | 文字列 | ||
| tax_type | 税区分 | 文字列 | 0:課税 1:非課税 2:免税 3:不課税 ※保存方式が「請求書等保存方式」で、かつ課税単位が「請求総額」の場合は設定されない。 |
|
| tax_rate_sec | 税率 | 数字 | 0:0% 5:5% 8:8% 10:10% ※保存方式が「請求書等保存方式」で、かつ課税単位が「請求総額」の場合は設定されない。 ※保存方式が「請求書等保存方式」で、かつ税区分指定が「指定しない」で、かつ課税単位が「明細単位」の場合は設定されない。 |
|
| reduced_tax_flg | 軽減税率フラグ | 文字列 | ○ | 0:軽減税率対象外 1:軽減税率対象 |
| input_tax_type | 税額入力形式区分 | 文字列 | 0:税抜 1:税込 2:手入力 |
|
| sum_exempt_flg | 合計対象外フラグ | 文字列 | ○ | 0:合計対象 1:合計対象外 |
| 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"の場合 型:数字 |
|
| 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 | 預金者名カナ | 文字列 | ||
| list_info | 一覧情報 | オブジェクト | ||
| product_sec | 作成方法 | 文字列 | "個別" "一括" |
|
| private_user_name | 自社担当者 | 文字列 | ||
| approver_name | 発行承認者 | 文字列 | ||
| billing_name | 請求先 | 文字列 | ||
| issue_user_name | 発行先担当者 | 文字列 | ||
| phone | 請求先電話番号 | 文字列 | 「XXXXX-XXXX-XXXX」の形式で出力する。 | |
| send_date | 請求書発行日 | 文字列(DateTime) | 「yyyy-MM-dd (JST)」の形式で出力する。 | |
| remind_date | 催促送信日時 | 文字列(DateTime) | 「yyyy-MM-dd HH:mi:ss (JST)」の形式で出力する。 | |
| seal_flg | 発行先確認状況 | boolean | true:確認済 false:未確認 |
|
| fax_send_flg | FAX送信 | boolean | ture:あり false:なし |
|
| qa_history | 質問歴あり | boolean | ture:あり false:なし |
|
| seal_date | 請求書確認日時 | 文字列(DateTime) | 「yyyy-MM-dd HH:mi:ss (JST)」の形式で出力する。 | |
| destination_code | 宛先コード | 文字列 | ||
| destination_name | 宛先名 | 文字列 | ||
| 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（数値）タイトル | 文字列 | ||
| 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（文字）タイトル | 文字列 | ||
| wf_status | ワークフローステータス | 文字列 | ○ | 10:作成 11:社内承認中 19:差戻受 20:発行承認中 21:発行予約済 22:発行済 23:発行済削除 29:発行エラー |
失敗時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | ○ | |
| error_item | エラー項目 | 文字列 | ||
| error_code | エラーコード | 文字列 | ○ | |
| error_detail | エラー内容 | 文字列 | ○ | |
| invoices[] | 請求書 | 配列 | null固定。 |
5. 処理詳細
5.1. API実行権限チェック
API利用ユーザーが有料会員かチェックを行う。
発行側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。
5.2. リクエストチェック
リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。
5.3. 請求書情報の取得処理
リクエストに該当する請求書情報を取得する。
5.4. 取得結果送信
取得した請求書情報をJSON/XML形式で返却する。
6. 備考・補足
特になし。
