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

請求書登録API

1. 概要

@請求書の登録および発行を行う。
A発行元のマスタ登録・更新・削除を行う。
B発行先のマスタ登録・更新を行う。招待方法が指定された場合は招待まで行う。
C振込先口座のマスタ登録・更新・削除を行う。

2. アクセス仕様

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

3. リクエスト(JSON/XML, UTF-8)

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

パラメータ名 名前 長さ・範囲 必須 備考
response_type レスポンス形式 文字列 4 "json"
"xml"
invoices[] 請求書 配列 -  
   publisher 発行元 オブジェクト -   ※)発行元の登録・更新・削除の条件は処理詳細5.3参照。
      publisher_mng_num 発行元コード 文字列 15 @発行元の削除時は必須。

画面にて同一の値で複数件登録されている発行元コードを指定すると、発行元特定不可エラーとなる。その際は画面にて発行元コードが一意になるように修正する必要がある。
      publisher_company_name 事業所・営業所名 文字列 30    
      publisher_section 部署 文字列 30    
      publisher_zip 郵便番号 文字列 8 @発行元コードが未設定時、または発行元の登録時は必須。

「XXX-XXXX」の形式で指定する。
      publisher_address1 住所 文字列 100 @発行元コードが未設定時、または発行元の登録時は「住所」または「住所(番地、建物名)」のどちらか一方は必須。
      publisher_address2 住所(番地、建物名) 文字列 100 @発行元コードが未設定時、または発行元の登録時は「住所」または「住所(番地、建物名)」のどちらか一方は必須。
      publisher_phone 電話番号 文字列 15 @発行元コードが未設定時、または発行元の登録時は必須。

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。
      publisher_del_flg 発行元削除フラグ 文字列 1   請求書情報がない場合のみ指定可能。
0:未設定
1:削除する
   invoice_setting_code 請求書書式設定コード 文字列 15   自社で作成した書式設定のみ指定可能。
発行先から追加された書式設定は指定不可。
   inv_no 請求書番号 文字列 20    
   customer 発行先 オブジェクト -   ※)発行先の登録・更新の条件は処理詳細5.4参照。
      private_cust_cd 発行先コード 文字列 15  
      user_email メールアドレス 文字列 100    
      user_name_1 文字列 15    
      user_name_2 文字列 15    
      user_name_kana_1 氏(カナ) 文字列 20    
      user_name_kana_2 名(カナ) 文字列 20    
      corp_genuine_id 法人番号 数字 13    
      company_name_org 会社名 文字列 60 @発行先の登録時は必須。

「長さ・範囲」はバイト表記。
全半角の英数記号カナが入力可能。
全角は2バイト、半角は1バイトとして最大長を評価する。
会社名と事業所・営業所名を両方指定する場合は合計60バイト以下で指定する。
      company_name_kana_org 会社名(カナ) 文字列 100   「長さ・範囲」はバイト表記。
全半角の英数記号カナが入力可能。
全角は2バイト、半角は1バイトとして最大長を評価する。
会社名(カナ)と事業所・営業所名(カナ)を両方指定する場合は合計100バイト以下で指定する。
      base_name 事業所・営業所名 文字列 60   「長さ・範囲」はバイト表記。
全半角の英数記号カナが入力可能。
全角は2バイト、半角は1バイトとして最大長を評価する。
会社名と事業所・営業所名を両方指定する場合は合計60バイト以下で指定する。
      base_name_kana 事業所・営業所名(カナ) 文字列 100   「長さ・範囲」はバイト表記。
全半角の英数記号カナが入力可能。
全角は2バイト、半角は1バイトとして最大長を評価する。
会社名(カナ)と事業所・営業所名(カナ)を両方指定する場合は合計100バイト以下で指定する。
      zip 会社郵便番号 文字列 8   「XXX-XXXX」の形式で指定する。
      address1 会社住所 文字列 100   会社住所と会社住所(番地、建物名等)で合計100文字以下で指定する。
      address2 会社住所(番地、建物名等) 文字列 100   会社住所と会社住所(番地、建物名等)で合計100文字以下で指定する。
      phone 会社電話番号 文字列 15   「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。
      fax 会社FAX番号 文字列 15   「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。
      private_user_employee_no 自社担当者社員コード 文字列 15   自社担当者社員コードと自社担当者名の両方を設定した場合、両方の条件に該当する社員を設定します。
      private_user_name 自社担当者名 文字列 30   自社担当者社員コードと自社担当者名の両方を設定した場合、両方の条件に該当する社員を設定します。
      invite_method 招待方法 文字列 1 下記のいずれかを指定された場合のみ発行先を招待する。
1:メールで招待
2:印刷で招待
4:FAXで招待
5:メール+FAX

請求書情報を設定し、かつ発行先が未登録または登録済みで未招待の場合、必須。

※)APIより自動で招待を行いたい場合は、メールアドレスも設定する。メールアドレスが未入力の場合、印刷またはFAXでの招待となり画面で招待のオペレーションを行う必要がある。
   invoice_title 請求書タイトル 文字列 12    
   inv_name 件名 文字列 40    
   pay_due_date 入金期限 文字列(DateTime) 10   「yyyy-MM-dd (JST)」の形式で指定する。
   payment_method 入金方法 文字列 1   0:銀行振込
1:口座振替
2:現金
3:手形
4:クレジットカード
5:小切手
6:コンビニ決済
9:その他

※)「銀行振込」以外を設定した場合、振込先口座情報を設定することはできない。
   prev_inv_amount 前回請求金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   payment 入金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   adjustment 調整金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   carryover_new 繰越金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax 今回請求金額(税抜) 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax 今回消費税額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount 今回請求金額(税込) 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   invoice_amount_title 請求金額タイトル 文字列 10    
   inv_show_amount おもての請求金額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   close_date 締日 文字列(DateTime) 10   「yyyy-MM-dd (JST)」の形式で指定する。
   remarks 備考 文字列 500    
   customer_code1 顧客コード1 文字列 10    
   customer_code2 顧客コード2 文字列 10    
   edi_info EDI情報 文字列 20    
   contact 担当 文字列 30    
   inv_free_txt1 おもての自由項目1(文字) 文字列 8    
   inv_free_txt2 おもての自由項目2(文字) 文字列 8    
   inv_free_txt3 おもての自由項目3(文字) 文字列 8    
   inv_free_num1 おもての自由項目1(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num2 おもての自由項目2(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num3 おもての自由項目3(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num4 おもての自由項目4(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num5 おもての自由項目5(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num6 おもての自由項目6(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_free_num7 おもての自由項目7(数値) 数字 13,3   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。
   inv_coop_post_use_type 請求書郵送代行サービス利用区分 文字列 1   郵送代行オプションを利用している場合のみ設定可能。

0:発行先マスタ・お申し込み時の設定を適用する
1:郵送代行を利用しない
2:郵送代行を利用する
   private_print_flg 自社印刷指定フラグ 文字列 1   発行済請求書一括印刷オプションを利用している場合のみ設定可能。

0:指定なし
1:指定あり
   inv_without_tax_tr10 10%請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_tr10 10%消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_tr10 10%請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_tr8_reduced 軽減8%請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_tr8_reduced 軽減8%消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_tr8_reduced 軽減8%請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_tr8 8%請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_tr8 8%消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_tr8 8%請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_tr5 5%請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_tr5 5%消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_tr5 5%請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_tr0 0%請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_tr0 0%消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_tr0 0%請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_free 非課税請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_free 非課税消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_free 非課税請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_exemption 免税請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_exemption 免税消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_exemption 免税請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_without_tax_non 不課税請求金額(税抜) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_tax_non 不課税消費税額 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   inv_amount_non 不課税請求金額(税込) 数字 13 マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
   details[] 明細情報 配列 -    
      item_slip_date 明細日付 文字列(DateTime) 10   「yyyy-MM-dd (JST)」の形式で指定する。
      item_slip_no 明細番号 文字列 20    
      item_prod_code 商品コード 文字列 48    
      item_name 明細項目 文字列 50    
      item_qty 数量 数字 13,5   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部5文字以下で指定する。
      item_price 単価 数字 13,5   マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部5文字以下で指定する。
      item_unit 単位 文字列 10    
      item_without_tax 金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
      item_tax 消費税額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
      item_amount 請求金額 数字 13   マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。
      item_sec_code 部門コード 文字列 15    
      item_sec_name 部門名 文字列 50    
      detail_remarks 備考 文字列 50    
      item_free_txt1 明細の自由項目1(文字) 文字列 20    
      item_free_txt2 明細の自由項目2(文字) 文字列 20    
      item_free_txt3 明細の自由項目3(文字) 文字列 20    
      item_free_txt4 明細の自由項目4(文字) 文字列 20    
      item_free_txt5 明細の自由項目5(文字) 文字列 20    
      item_free_txt6 明細の自由項目6(文字) 文字列 20    
      item_free_txt7 明細の自由項目7(文字) 文字列 20    
      item_free_txt8 明細の自由項目8(文字) 文字列 20    
      item_free_txt9 明細の自由項目9(文字) 文字列 20    
      item_free_txt10 明細の自由項目10(文字) 文字列 20    
      item_free_txt_l 明細の自由項目11(文字) 文字列 100    
      tax_type 税区分 文字列 1   0:課税
1:非課税
2:免税
3:不課税
      tax_rate_sec 税率 数字 3 0:0%
5:5%
8:8%
10:10%
      reduced_tax_flg 軽減税率フラグ 文字列 1   0:軽減税率対象外
1:軽減税率対象
      input_tax_type 税額入力形式区分 文字列 1   0:税抜
1:税込
2:手入力
      sum_exempt_flg 合計対象外フラグ 文字列 1   0:合計対象
1:合計対象外
   custom_header カスタムヘッダー情報 オブジェクト -
      custom_name カスタム名 文字列 8 カスタム明細ヘッダー情報が1件以上ある場合は必須。
      custom_detail_headers[] カスタム明細ヘッダー情報 配列 - 指定できる要素数は9件まで。
         field_seq 項目連番 数字 1 項目連番、項目名、データ型、小数点以下桁数、列幅のいずれかが指定された場合、必須。
1〜9の連番でユニークとなるように指定。
カスタム明細データ情報.項目連番とリンクする。
         field_name 項目名 文字列 15 項目連番、項目名、データ型、小数点以下桁数、列幅のいずれかが指定された場合、必須。
         field_type データ型 文字列 1 項目連番、項目名、データ型、小数点以下桁数、列幅のいずれかが指定された場合、必須。

"S":文字列
"N":数字
         field_num_decimal_places 小数点以下桁数 数字 1 データ型が"N"の場合、0〜3で指定。未指定の場合は0となる。
データ型が"S"の場合、指定不要。
         field_col_width 列幅 数字 3 項目連番、項目名、データ型、小数点以下桁数、列幅のいずれかが指定された場合、必須。
1〜100で指定(単位:%)。
カスタム明細ヘッダー情報の全列幅の合計が100になるように指定する。
   custom_details[] カスタム明細情報 配列 -
      custom_detail_values[] カスタム明細データ情報 配列 - 指定できる要素数は9件まで。
         field_seq 項目連番 数字 1 項目連番、データ値のいずれかが指定された場合、必須。
1〜9の連番でユニークとなるように指定。
カスタム明細ヘッダー情報.項目連番とリンクする。
         field_value データ値 項目連番、データ値のいずれかが指定された場合、必須。


@カスタム明細ヘッダー情報.データ型が"S"の場合
型:文字列
桁数50桁
Aカスタム明細ヘッダー情報.データ型が"N"の場合
型:数字
整数部桁数13桁
小数部桁数:カスタム明細ヘッダー情報.小数点以下桁数
   banks[] 振込先口座情報 配列 -   ※)振込先口座の登録・更新・削除の条件は処理詳細5.6.参照。
      transfer_code 振込先コード 文字列 15 @振込先口座の更新時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須。
A振込先口座の削除時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須(ただしどちらか一方のみしか設定できない)。

※)APIから金融機関コード・支店コード・口座番号を更新する際には振込先コードが必要になる。そのため振込先口座の登録時は必須ではないが設定することを推奨する。
      fncl_inst_code 金融機関コード 文字列 4 @振込先口座の登録時は必須。
A振込先口座の更新時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須。
B振込先口座の削除時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須(ただしどちらか一方のみしか設定できない)。
      fncl_inst_name 金融機関名 文字列 15 @振込先口座の登録時は必須。
      fncl_inst_kana 金融機関名カナ 文字列 15 @振込先口座の登録時は必須。
      branch_code 支店コード 文字列 3 @振込先口座の登録時は必須。
A振込先口座の更新時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須。
B振込先口座の削除時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須(ただしどちらか一方のみしか設定できない)。
      branch_name 支店名 文字列 15 @振込先口座の登録時は必須。
      branch_kana 支店名カナ 文字列 15 @振込先口座の登録時は必須。
      deposit_sec 預金種別 文字列 1 @振込先口座の登録時は必須。

1:普通預金
2:当座預金
4:貯蓄預金
9:その他
      account_num 口座番号 文字列 7 @振込先口座の登録時は必須。
A振込先口座の更新時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須。
B振込先口座の削除時は振込先コードまたは金融機関キー情報(金融機関コード+支店コード+口座番号)のいずれかが必須(ただしどちらか一方のみしか設定できない)。
      depositor_name 預金者名 文字列 30 @振込先口座の登録時は必須。
      depositor_kana 預金者名カナ 文字列 30 @振込先口座の登録時は必須。
      bank_del_flg 振込先口座削除フラグ 文字列 1   請求書情報が未設定の場合のみ設定可能。
0:未設定
1:削除する
unit_tax_calc_sec 課税単位 文字列 1   0:請求総額
1:明細単位

未設定の場合は請求書書式設定(注1)の課税単位が設定される。
fax_send_flg FAX送信フラグ 文字列 1   0:なし
1:あり

(注1)請求書書式設定はAPIからは設定できません。画面より設定を行ってください。

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. 発行元の登録・更新・削除処理

リクエストで指定された発行元が未登録の場合、登録を行う。
リクエストで指定された発行元が登録済の場合、更新を行う。
リクエストで指定された発行元が登録済で、かつリクエストで削除が指定された場合、削除を行う(削除は請求書情報を含まない場合のみ可能)。

5.4. 発行先の登録・更新処理

リクエストで指定された発行先が未登録の場合、登録を行う。
リクエストで指定された発行先が登録済で、かつ登録済情報と変更がある場合、更新を行う。

5.5. 発行先の招待処理

リクエストで指定された発行先が登録済でかつ未招待の場合、招待を行う。

5.6. 振込先口座の登録・更新・削除処理

リクエストで指定された振込先口座が未登録の場合、登録を行う。
リクエストで指定された振込先口座が登録済で、かつ登録済情報と変更がある場合、更新を行う。
リクエストで指定された振込先口座が登録済で、かつリクエストで削除が指定された場合、削除を行う(削除は請求書情報を含まない場合のみ可能)。

5.7. 請求書の登録処理

リクエストで指定された請求書を登録する。

5.8. 請求書の発行処理

登録された請求書を発行先へ発行する。

5.9. 振処理結果送信

処理結果をJSON/XML形式で返却する。

6. 備考・補足

請求書登録APIの特性上、請求書登録APIのレスポンスと実際の請求書発行の間にはタイムラグが発生する。
また、請求書登録APIのレスポンス順序と実際の請求書発行順序は一致しない場合がある。

複数件の請求書データを1リクエストに設定した場合に、一部の請求書がエラーであった場合の処理方法は、
エラーがあった請求書のみ処理を中断して、それ以外の請求書は作成される。
レスポンスのエラーリストの内容をもとに、エラーとなった請求書データのみ再度リクエストを行う制御が必要となる。