logo-pf
API docs by Redocly

請求書 (2.0.0)

Download OpenAPI specification:Download

発行請求書

請求書一覧取得

  • 概要：発行した請求書データを取得する。
  • 備考・補足： 保存方式が「フリーフォーマット」かつ、課税単位が「伝票単位」の請求書を発行しているケースにおいて、
    リクエストの保存方式を指定なしでリクエストした場合、レスポンスの 課税単位：「請求総額」「明細単位」と、
    保存方式：「フリーフォーマット」、課税単位：「伝票単位」が混在してレスポンスされる。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

send_date_from
required
string <date> (発行日(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

send_date_to
required
string <date> (発行日(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_from
string <date> (入金期限（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_to
string <date> (入金期限（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

close_date
string <date> (締日) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

invoice_type
string (保存方式) <= 1 characters

どの保存方式の請求書を抽出するか。
0：請求書等保存方式
1：区分記載請求書等保存方式
2：フリーフォーマット
3：適格請求書等保存方式
4：適格請求書等保存方式（明細ごとに消費税を入力）

seal_flg
string (発行先確認状況) <= 1 characters

0：未開封
1：開封済み

extracting_type01
string (抽出種別(再発行)) <= 1 characters

再発行された請求書を抽出するか。
0：未設定
1：抽出する

extracting_type02
string (抽出種別(新規)) <= 1 characters

新規取引先の請求書を抽出するか。
0：未設定
1：抽出する

extracting_type03
string (抽出種別(差戻し)) <= 1 characters

①受取側企業より差戻しされた場合
上記の請求書を抽出するか。
0：未設定
1：抽出する

extracting_type04
string (抽出種別(削除)) <= 1 characters

削除された請求書を抽出するか。
0：未設定
1：抽出する

extracting_type05
string (抽出種別(FAXエラー)) <= 1 characters

FAX送信エラーとなった請求書を抽出するか。
0：未設定
1：抽出する

extracting_type06
string (抽出種別(質問歴あり)) <= 1 characters

質問歴のある請求書を抽出するか。
0：未設定
1：抽出する

extracting_type07
string (抽出種別(未催促)) <= 1 characters

未催促の請求書を抽出するか。
0：未設定
1：抽出する

extracting_type08
string (抽出種別(発行済削除)) <= 1 characters

発行済削除の請求書を抽出するか。
0：未設定
1：抽出する

customer_mng_num
string (発行先コード) <= 13 characters

例）CM_9876543210

private_user_id
string (自社担当者社員コード) <= 100 characters

プラットフォームIDで指定

external_data_flg
string (外部連携フラグ) <= 1 characters

0：外部連携以外
2：API作成

coop_post_use_setting_type
string (郵送代行利用状況) <= 1 characters

空白または0：全て
1：未利用
2：利用中（処理中 発送済 発送中止 不達）

coop_post_delivery_date_from
string <date> (郵送代行発送日（From）) <= 10 characters

郵送代行利用状況で、2：利用中指定時のみ設定。
「yyyy-MM-dd (JST)」の形式で指定する。

coop_post_delivery_date_to
string <date> (郵送代行発送日（To）) <= 10 characters

郵送代行利用状況で、2：利用中指定時のみ設定。
「yyyy-MM-dd (JST)」の形式で指定する。

inv_show_amount_from
string (請求金額（From）) <= 13 characters

整数部13桁

inv_show_amount_to
string (請求金額（To）) <= 13 characters

整数部13桁

keyword
string (キーワード) <= 200 characters

発行先、発行先コード、住所、TEL、案件名、請求書番号、発行先担当者、件名を部分一致で取得

invoice_mng_num
string (請求書管理番号) <= 10 characters

完全一致で取得

customer_company_name
string (発行先) <= 200 characters

完全一致で取得

customer_address
string (住所) <= 200 characters

住所1または住所2に完全一致で取得

customer_phone
string (TEL) <= 24 characters

完全一致で取得

comp_inv_name
string (案件名) <= 200 characters

完全一致で取得

inv_no
string (請求書番号) <= 20 characters

完全一致で取得

customer_name
string (発行先担当者) <= 80 characters

完全一致で取得

inv_name
string (件名) <= 80 characters

完全一致で取得

sort
string (並び順) <= 1 characters

0または空白：発行日(昇順)
1：発行日(降順)
2：入金期限(昇順)
3：入金期限(降順)
4：請求金額(昇順)
5：請求金額(降順)

start_position
string (取得開始位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、取得件数で指定した件数を返却する。（指定が無い場合は指定位置から100件を返却）

get_count
string (取得件数) <= 2 characters

指定がない場合は100件を返却。
1~99の範囲で数値を指定し、指定された件数のデータを返却。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "send_date_from": "yyyy-MM-dd",
  • "send_date_to": "yyyy-MM-dd",
  • "pay_due_date_from": "yyyy-MM-dd",
  • "pay_due_date_to": "yyyy-MM-dd",
  • "close_date": "yyyy-MM-dd",
  • "invoice_type": "string",
  • "seal_flg": "string",
  • "extracting_type01": "string",
  • "extracting_type02": "string",
  • "extracting_type03": "string",
  • "extracting_type04": "string",
  • "extracting_type05": "string",
  • "extracting_type06": "string",
  • "extracting_type07": "string",
  • "extracting_type08": "string",
  • "customer_mng_num": "string",
  • "private_user_id": "string",
  • "external_data_flg": "string",
  • "coop_post_use_setting_type": "string",
  • "coop_post_delivery_date_from": "yyyy-MM-dd",
  • "coop_post_delivery_date_to": "yyyy-MM-dd",
  • "inv_show_amount_from": "string",
  • "inv_show_amount_to": "string",
  • "keyword": "string",
  • "invoice_mng_num": "string",
  • "customer_company_name": "string",
  • "customer_address": "string",
  • "customer_phone": "string",
  • "comp_inv_name": "string",
  • "inv_no": "string",
  • "customer_name": "string",
  • "inv_name": "string",
  • "sort": "string",
  • "start_position": "string",
  • "get_count": "string"
}

Response samples

Content type
Example
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoices[]": [
    ],
  • "total_count": "string"
}

請求書登録

  • 概要：請求書の登録および発行を行う。（リクエスト配列は、請求書書式で設定している課税単位が「請求総額」「明細単位」の場合）
Request Body schema:
One of
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_title
string (請求書タイトル) <= 12 characters
inv_no
string (請求書番号) <= 20 characters
invoice_amount_title
string (請求金額タイトル) <= 10 characters
contact
string (担当(問い合わせ先)) <= 30 characters
close_date
string <date> (締日) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date
string <date> (入金期限) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

inv_name
string (件名) <= 40 characters
inv_show_amount
required
string (おもての請求金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

customer_mng_num_buyer
required
string (発行先管理番号) <= 13 characters

発行先管理番号は「CM_」の3文字を付与の上「CM_xxxxxxxxxx」で指定する。

publisher_mng_num
string (発行元管理番号) <= 10 characters
invoice_setting_mng_num
string (請求書書式設定管理番号) <= 10 characters

自社で作成した書式設定のみ指定可能。
発行先から追加された書式設定は指定不可。

payment_method
string (入金方法) <= 1 characters

0：銀行振込
1：口座振替
2：現金
3：手形
4：クレジットカード
5：小切手
6：コンビニ決済
9：その他

※）「銀行振込」以外を設定した場合、振込先口座情報を設定することはできない。

prev_inv_amount
string (前回請求金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

payment
string (入金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

adjustment
string (調整金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

carryover_new
string (繰越金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax
string (今回請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax
string (今回消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount
string (今回請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr10
string (10%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr10
string (10%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr10
string (10%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr8_reduced
string (軽減8%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr8_reduced
string (軽減8%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr8_reduced
string (軽減8%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr8
string (8%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr8
string (8%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr8
string (8%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr5
string (5%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr5
string (5%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr5
string (5%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr0
string (0%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr0
string (0%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr0
string (0%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_free
string (非課税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_free
string (非課税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_free
string (非課税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_exemption
string (免税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_exemption
string (免税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_exemption
string (免税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_non
string (不課税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_non
string (不課税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_non
string (不課税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_free_txt1
string (おもての自由項目1（文字）) <= 8 characters
inv_free_txt2
string (おもての自由項目2（文字）) <= 8 characters
inv_free_txt3
string (おもての自由項目3（文字）) <= 8 characters
inv_free_num1
string (おもての自由項目1（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num2
string (おもての自由項目2（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num3
string (おもての自由項目3（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num4
string (おもての自由項目4（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num5
string (おもての自由項目5（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num6
string (おもての自由項目6（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num7
string (おもての自由項目7（数値）) <= 18 characters

マイナス記号、小数点は許可。
マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

remarks
string (備考) <= 500 characters
customer_code1
string (顧客コード1) <= 10 characters
customer_code2
string (顧客コード2) <= 10 characters
edi_info
string (EDI情報) <= 20 characters
bank_mng_num[]
Array of objects (振込先口座管理番号)

10件まで登録可能
管理番号は半角数字10文字以内

Array of objects (明細情報)
object (カスタム情報)
inv_coop_post_use_type
string (請求書郵送代行サービス利用区分) <= 1 characters

郵送代行オプションを利用している場合のみ設定可能。

0：発行先マスタ・お申し込み時の設定を適用する
1：郵送代行を利用しない
2：郵送代行を利用する

private_print_flg
string (自社印刷指定フラグ) <= 1 characters

発行済請求書一括印刷オプションを利用している場合のみ設定可能。

0：指定なし
1：指定あり

fax_send_flg
string (FAX送信フラグ) <= 1 characters

0：なし
1：あり

Responses

Request samples

Content type
Example
{
  • "response_type": "string",
  • "invoice_title": "string",
  • "inv_no": "string",
  • "invoice_amount_title": "string",
  • "contact": "string",
  • "close_date": "yyyy-MM-dd",
  • "pay_due_date": "yyyy-MM-dd",
  • "inv_name": "string",
  • "inv_show_amount": "string",
  • "customer_mng_num_buyer": "string",
  • "publisher_mng_num": "string",
  • "invoice_setting_mng_num": "string",
  • "payment_method": "string",
  • "prev_inv_amount": "string",
  • "payment": "string",
  • "adjustment": "string",
  • "carryover_new": "string",
  • "inv_without_tax": "string",
  • "inv_tax": "string",
  • "inv_amount": "string",
  • "inv_without_tax_tr10": "string",
  • "inv_tax_tr10": "string",
  • "inv_amount_tr10": "string",
  • "inv_without_tax_tr8_reduced": "string",
  • "inv_tax_tr8_reduced": "string",
  • "inv_amount_tr8_reduced": "string",
  • "inv_without_tax_tr8": "string",
  • "inv_tax_tr8": "string",
  • "inv_amount_tr8": "string",
  • "inv_without_tax_tr5": "string",
  • "inv_tax_tr5": "string",
  • "inv_amount_tr5": "string",
  • "inv_without_tax_tr0": "string",
  • "inv_tax_tr0": "string",
  • "inv_amount_tr0": "string",
  • "inv_without_tax_free": "string",
  • "inv_tax_free": "string",
  • "inv_amount_free": "string",
  • "inv_without_tax_exemption": "string",
  • "inv_tax_exemption": "string",
  • "inv_amount_exemption": "string",
  • "inv_without_tax_non": "string",
  • "inv_tax_non": "string",
  • "inv_amount_non": "string",
  • "inv_free_txt1": "string",
  • "inv_free_txt2": "string",
  • "inv_free_txt3": "string",
  • "inv_free_num1": "string",
  • "inv_free_num2": "string",
  • "inv_free_num3": "string",
  • "inv_free_num4": "string",
  • "inv_free_num5": "string",
  • "inv_free_num6": "string",
  • "inv_free_num7": "string",
  • "remarks": "string",
  • "customer_code1": "string",
  • "customer_code2": "string",
  • "edi_info": "string",
  • "bank_mng_num[]": [
    ],
  • "details[]": [
    ],
  • "custom": {
    },
  • "inv_coop_post_use_type": "string",
  • "private_print_flg": "string",
  • "fax_send_flg": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_mng_num": "string"
}

請求書更新

  • 概要：請求書の更新および再発行を行う。（リクエスト配列は、課税単位が請求総額、明細単位の場合）
Request Body schema:
One of
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_mng_num
required
string (請求書管理番号) <= 10 characters
invoice_title
string (請求書タイトル) <= 12 characters
inv_no
string (請求書番号) <= 20 characters
invoice_amount_title
string (請求金額タイトル) <= 10 characters
contact
string (担当(問い合わせ先)) <= 30 characters
close_date
string <date> (締日) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date
string <date> (入金期限) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

inv_name
string (件名) <= 40 characters
inv_show_amount
required
string (おもての請求金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

publisher_mng_num
string (発行元管理番号) <= 10 characters
payment_method
string (入金方法) <= 1 characters

0：銀行振込
1：口座振替
2：現金
3：手形
4：クレジットカード
5：小切手
6：コンビニ決済
9：その他

※）「銀行振込」以外を設定した場合、振込先口座情報を設定することはできない。

prev_inv_amount
string (前回請求金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

payment
string (入金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

adjustment
string (調整金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

carryover_new
string (繰越金額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax
string (今回請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax
string (今回消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount
string (今回請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr10
string (10%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr10
string (10%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr10
string (10%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr8_reduced
string (軽減8%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr8_reduced
string (軽減8%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr8_reduced
string (軽減8%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr8
string (8%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr8
string (8%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr8
string (8%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr5
string (5%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr5
string (5%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr5
string (5%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_tr0
string (0%請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_tr0
string (0%消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_tr0
string (0%請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_free
string (非課税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_free
string (非課税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_free
string (非課税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_exemption
string (免税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_exemption
string (免税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_exemption
string (免税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_without_tax_non
string (不課税請求金額（税抜）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_tax_non
string (不課税消費税額) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_amount_non
string (不課税請求金額（税込）) <= 13 characters

マイナス記号は許可。
マイナス記号を除いて13文字以下で指定する。

inv_free_txt1
string (おもての自由項目1（文字）) <= 8 characters
inv_free_txt2
string (おもての自由項目2（文字）) <= 8 characters
inv_free_txt3
string (おもての自由項目3（文字）) <= 8 characters
inv_free_num1
string (おもての自由項目1（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num2
string (おもての自由項目2（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num3
string (おもての自由項目3（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num4
string (おもての自由項目4（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num5
string (おもての自由項目5（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num6
string (おもての自由項目6（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

inv_free_num7
string (おもての自由項目7（数値）) <= 18 characters

マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。

remarks
string (備考) <= 500 characters
customer_code1
string (顧客コード1) <= 10 characters
customer_code2
string (顧客コード2) <= 10 characters
edi_info
string (EDI情報) <= 20 characters
bank_mng_num[]
Array of objects (振込先口座管理番号)

10件まで登録可能 管理番号は半角数字10文字以内

Array of objects (明細情報)
object (カスタム情報)
inv_coop_post_use_type
string (請求書郵送代行サービス利用区分) <= 1 characters

郵送代行オプションを利用している場合のみ設定可能。

0：発行先マスタ・お申し込み時の設定を適用する 1：郵送代行を利用しない 2：郵送代行を利用する

private_print_flg
string (自社印刷指定フラグ) <= 1 characters

発行済請求書一括印刷オプションを利用している場合のみ設定可能。

0：指定なし 1：指定あり

fax_send_flg
string (FAX送信フラグ) <= 1 characters

0：なし 1：あり

Responses

Request samples

Content type
Example
{
  • "response_type": "string",
  • "invoice_mng_num": "string",
  • "invoice_title": "string",
  • "inv_no": "string",
  • "invoice_amount_title": "string",
  • "contact": "string",
  • "close_date": "yyyy-MM-dd",
  • "pay_due_date": "yyyy-MM-dd",
  • "inv_name": "string",
  • "inv_show_amount": "string",
  • "publisher_mng_num": "string",
  • "payment_method": "string",
  • "prev_inv_amount": "string",
  • "payment": "string",
  • "adjustment": "string",
  • "carryover_new": "string",
  • "inv_without_tax": "string",
  • "inv_tax": "string",
  • "inv_amount": "string",
  • "inv_without_tax_tr10": "string",
  • "inv_tax_tr10": "string",
  • "inv_amount_tr10": "string",
  • "inv_without_tax_tr8_reduced": "string",
  • "inv_tax_tr8_reduced": "string",
  • "inv_amount_tr8_reduced": "string",
  • "inv_without_tax_tr8": "string",
  • "inv_tax_tr8": "string",
  • "inv_amount_tr8": "string",
  • "inv_without_tax_tr5": "string",
  • "inv_tax_tr5": "string",
  • "inv_amount_tr5": "string",
  • "inv_without_tax_tr0": "string",
  • "inv_tax_tr0": "string",
  • "inv_amount_tr0": "string",
  • "inv_without_tax_free": "string",
  • "inv_tax_free": "string",
  • "inv_amount_free": "string",
  • "inv_without_tax_exemption": "string",
  • "inv_tax_exemption": "string",
  • "inv_amount_exemption": "string",
  • "inv_without_tax_non": "string",
  • "inv_tax_non": "string",
  • "inv_amount_non": "string",
  • "inv_free_txt1": "string",
  • "inv_free_txt2": "string",
  • "inv_free_txt3": "string",
  • "inv_free_num1": "string",
  • "inv_free_num2": "string",
  • "inv_free_num3": "string",
  • "inv_free_num4": "string",
  • "inv_free_num5": "string",
  • "inv_free_num6": "string",
  • "inv_free_num7": "string",
  • "remarks": "string",
  • "customer_code1": "string",
  • "customer_code2": "string",
  • "edi_info": "string",
  • "bank_mng_num[]": [
    ],
  • "details[]": [
    ],
  • "custom": {
    },
  • "inv_coop_post_use_type": "string",
  • "private_print_flg": "string",
  • "fax_send_flg": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_mng_num": "string"
}

発行先

発行先取得

  • 概要：登録済みの発行先情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invite_status
string (招待履歴) <= 1 characters

0または未指定：全て
1：未招待
2：招待済
※招待履歴と招待先のログイン状況フラグの組み合わせに関する補足はAppendixの「招待履歴」と「招待先のログイン状況」フラグの組み合わせを参照。

login_flg
string (招待先のログイン状況) <= 1 characters

0または未指定：全て
1：ログイン済
2：未ログイン

※招待履歴が「1：未招待」かつ、「1：ログイン済」を指定した場合は、パターンが無いためデータの取得は行えない。
※招待履歴と招待先のログイン状況フラグの組み合わせに関する補足はAppendixの「招待履歴」と「招待先のログイン状況」フラグの組み合わせを参照。

update_date_from
string <date> (更新日（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

update_date_to
string <date> (更新日（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

inv_create_date
string (請求書発行履歴) <= 10 characters

0または未指定：全て
1：未発行
2：発行済

inv_last_send_date_from
string <date> (請求書最終発行日（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

inv_last_send_date_to
string <date> (請求書最終発行日（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

view_active
string (非表示設定) <= 1 characters

0または未指定：表示のみ
1：非表示のみ

private_user_id
string (自社担当者PFID) <= 100 characters

プラットフォームIDを指定

keyword
string (キーワード) <= 200 characters

事業所・営業所名、発行先担当者名、メールアドレス、発行先コードから部分一致で取得

customer_mng_num
string (発行先管理番号) <= 13 characters

完全一致で取得
NI_9999999999／CM_9999999999の形式で指定

company_name_org
string (事業所・営業所) <= 200 characters

完全一致で取得

private_user_name
string (発行先担当者) <= 200 characters

完全一致で取得

user_email
string (メールアドレス) <= 200 characters

完全一致で取得

private_cust_cd
string (発行先コード) <= 15 characters

完全一致で取得

start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、指定位置から最大100件を返却する。

sort
string (並び順) <= 1 characters

0または空白：企業名(昇順)
1：企業名(降順)
2：発行先コード(昇順)
3：発行先コード(降順)
4：更新日(昇順)
5：更新日(降順)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invite_status": "string",
  • "login_flg": "string",
  • "update_date_from": "yyyy-MM-dd",
  • "update_date_to": "yyyy-MM-dd",
  • "inv_create_date": "string",
  • "inv_last_send_date_from": "yyyy-MM-dd",
  • "inv_last_send_date_to": "yyyy-MM-dd",
  • "view_active": "string",
  • "private_user_id": "string",
  • "keyword": "string",
  • "customer_mng_num": "string",
  • "company_name_org": "string",
  • "private_user_name": "string",
  • "user_email": "string",
  • "private_cust_cd": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customers[]": [
    ],
  • "total_count": "string"
}

発行先登録

  • 概要：発行先の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

private_cust_cd
string (発行先コード) <= 15 characters
user_mail
string (メールアドレス) <= 100 characters

メールアドレスは半角100文字以内

user_name_sei
string (氏) <= 15 characters

氏は全角15文字以内

user_name_mei
string (名) <= 15 characters

名は全角15文字以内

user_name_sei_kana
string (氏カナ) <= 20 characters
user_name_mei_kana
string (名カナ) <= 20 characters
corp_geniuine_id
string (法人番号) <= 13 characters
company_name_org
required
string (企業名) <= 60 characters

会社名は法人格、事業所・営業所名とあわせて全角30文字以内、半角60文字以内

company_name_kana_org
string (企業名(カナ)) <= 100 characters

会社名（カナ）は事業所・営業所名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

base_name
string (事業所・営業署名) <= 60 characters

事業所・営業所名は法人格、会社名とあわせて全角30文字以内、半角60文字以内

base_name_kana
string (事業所・営業署名(カナ)) <= 100 characters

事業所・営業所名（カナ）は会社名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1(市区町村)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2(番地、建物名等)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

phone
string (TEL) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

private_user_id
required
string (自社担当者PFID) <= 100 characters

自社担当者のプラットフォームIDを指定

Array of objects (振込先口座(配列))
coop_post_use_flg
string (郵送代行サービス利用区分（請求書）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_flg
string (郵送代行サービス利用区分（招待）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_type
string (郵送請求書/通知書タイプ) <= 1 characters

0：初期設定を利用する
4：はがき4面
5：封書(明細のみ)
6：封書(カスタム明細のみ)
7：封書(明細＋カスタム明細)
8：はがき6面
※郵送代行オプションを利用している場合のみ設定可能

auto_refrect_flg
string (自動反映設定フラグ) <= 1 characters

0：自動反映しない
1：自動反映する
2：初期設定を使用する

auto_refrect_item
Array of objects (自動反映項目)

自動反映設定フラグを「自動反映する」場合に必須となる。
指定例）["1","32","128"]

1：法人番号
2：会社名
4：会社名（カナ）
8：事業所・営業所名
16：事業所・営業所名（カナ）
32：電話番号
64：FAX番号
128：郵便番号
256：住所

Array of objects (締日・入金期限(配列))

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "private_cust_cd": "string",
  • "user_mail": "string",
  • "user_name_sei": "string",
  • "user_name_mei": "string",
  • "user_name_sei_kana": "string",
  • "user_name_mei_kana": "string",
  • "corp_geniuine_id": "string",
  • "company_name_org": "string",
  • "company_name_kana_org": "string",
  • "base_name": "string",
  • "base_name_kana": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "phone": "string",
  • "fax": "string",
  • "private_user_id": "string",
  • "bank_mng_num[]": [
    ],
  • "coop_post_use_flg": "string",
  • "coop_post_use_invite_flg": "string",
  • "coop_post_type": "string",
  • "auto_refrect_flg": "string",
  • "auto_refrect_item": [
    ],
  • "closing_days[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

発行先更新

  • 概要：発行先情報の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

customer_mng_num
required
string (発行先管理番号) <= 13 characters

番号の先頭に以下の文字列を付与して出力。
未招待の場合：NI_
招待済みの場合：CM_

private_cust_cd
string (発行先コード) <= 15 characters
user_mail
string (メールアドレス) <= 100 characters

メールアドレスは半角100文字以内

user_name_sei
string (氏) <= 15 characters

氏は全角15文字以内

user_name_mei
string (名) <= 15 characters

名は全角15文字以内

user_name_sei_kana
string (氏カナ) <= 20 characters
user_name_mei_kana
string (名カナ) <= 20 characters
corp_geniuine_id
string (法人番号) <= 13 characters
company_name_org
required
string (企業名) <= 60 characters

会社名は法人格、事業所・営業所名とあわせて全角30文字以内、半角60文字以内

company_name_kana_org
string (企業名(カナ)) <= 100 characters

会社名（カナ）は事業所・営業所名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

base_name
string (事業所・営業署名) <= 60 characters

事業所・営業所名は法人格、会社名とあわせて全角30文字以内、半角60文字以内

base_name_kana
string (事業所・営業署名(カナ)) <= 100 characters

事業所・営業所名（カナ）は会社名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1(市区町村)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2(番地、建物名等)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

phone
string (TEL) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

private_user_id
required
string (自社担当者PFID) <= 100 characters

自社担当者のプラットフォームIDを指定

Array of objects (振込先口座(配列))
coop_post_use_flg
string (郵送代行サービス利用区分（請求書）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_flg
string (郵送代行サービス利用区分（招待）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_type
string (郵送請求書/通知書タイプ) <= 1 characters

0：初期設定を利用する
4：はがき4面
5：封書(明細のみ)
6：封書(カスタム明細のみ)
7：封書(明細＋カスタム明細)
8：はがき6面
※郵送代行オプションを利用している場合のみ設定可能

auto_refrect_flg
string (自動反映設定フラグ) <= 1 characters

0：自動反映しない
1：自動反映する
2：初期設定を使用する

auto_refrect_item
Array of objects (自動反映項目)

自動反映設定フラグを「自動反映する」場合に必須となる。
指定例）["1","32","128"]

1：法人番号
2：会社名
4：会社名（カナ）
8：事業所・営業所名
16：事業所・営業所名（カナ）
32：電話番号
64：FAX番号
128：郵便番号
256：住所

Array of objects (締日・入金期限(配列))

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "customer_mng_num": "string",
  • "private_cust_cd": "string",
  • "user_mail": "string",
  • "user_name_sei": "string",
  • "user_name_mei": "string",
  • "user_name_sei_kana": "string",
  • "user_name_mei_kana": "string",
  • "corp_geniuine_id": "string",
  • "company_name_org": "string",
  • "company_name_kana_org": "string",
  • "base_name": "string",
  • "base_name_kana": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "phone": "string",
  • "fax": "string",
  • "private_user_id": "string",
  • "bank_mng_num[]": [
    ],
  • "coop_post_use_flg": "string",
  • "coop_post_use_invite_flg": "string",
  • "coop_post_type": "string",
  • "auto_refrect_flg": "string",
  • "auto_refrect_item": [
    ],
  • "closing_days[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

発行先招待

  • 概要：発行先へ招待を行う。
  • 備考・補足：
    初回招待のみ可能。再招待を行うことはできない。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

customer_mng_num
required
string (発行先管理番号) <= 13 characters

番号の先頭に以下の文字列を付与して指定。
未招待の場合：NI_
※招待済みのデータ(CM_xxxxxxxxxx)が指定された場合はエラー

invite_method
required
integer (招待方法) <= 10 characters

1：メールで招待
2：印刷で招待
4：FAXで招待
5：メール＋FAX

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "customer_mng_num": "string",
  • "invite_method": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

発行元

発行元取得

  • 概要：発行元（請求元・送付元表示マスタ）の取得を行う
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 30 characters

検索対象：表示コード、事業所・営業所名、部署名を部分一致で取得

publisher_code
string (表示コード（検索用）) <= 15 characters

完全一致で取得

publisher_company_name
string (事業所・営業所名（検索用）) <= 30 characters

完全一致で取得

publisher_section
string (部署名) <= 30 characters

全角30文字以内で指定する。
※完全一致で取得

sort
string (並び順) <= 1 characters

0または未指定：表示コード（昇順）
1：表示コード（降順）
2：更新日（昇順）
3：更新日（降順）
4：事業所・営業所名（昇順）
5：事業所・営業所名（降順）

start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。 指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。 (例：1を指定→1～100件目、5を指定→5～104件目)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "publisher_code": "string",
  • "publisher_company_name": "string",
  • "publisher_section": "string",
  • "sort": "string",
  • "start_position": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "publisher": {
    },
  • "total_count": "string"
}

発行元登録

  • 概要：発行元（請求元・送付元表示マスタ）の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

publisher_code
string (表示コード) <= 15 characters
publisher_company_name
string (事業所・営業所名) <= 30 characters
publisher_section
string (部署) <= 30 characters
publisher_zip
required
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

publisher_area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

publisher_address1
string (住所（市区町村）) <= 96 characters

市区町村を入力
住所（市区町村）と住所（番地、建物名）を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所（市区町村）+住所（番地、建物名）」で合わせて全角100文字以内で登録する。（各間の1文字含む）

publisher_address2
string (住所（番地、建物名）) <= 96 characters

番地・建物名を入力
住所（市区町村）と住所（番地、建物名）を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所（市区町村）+住所（番地、建物名）」で合わせて全角100文字以内で登録する。（各間の1文字含む）

publisher_phone
required
string (電話番号) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "publisher_code": "string",
  • "publisher_company_name": "string",
  • "publisher_section": "string",
  • "publisher_zip": "string",
  • "publisher_area_code": "string",
  • "publisher_address1": "string",
  • "publisher_address2": "string",
  • "publisher_phone": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "publisher_mng_num": "string"
}

発行元更新

  • 概要：発行元（請求元・送付元表示マスタ）の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

publisher_mng_num
required
string (発行元管理番号) <= 10 characters
publisher_code
string (表示コード) <= 15 characters
publisher_company_name
string (事業所・営業所名) <= 30 characters
publisher_section
string (部署) <= 30 characters
publisher_zip
required
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

publisher_area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

publisher_address1
string (住所（市区町村）) <= 96 characters

市区町村を入力
住所（市区町村）と住所（番地、建物名）を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所（市区町村）+住所（番地、建物名）」で合わせて全角100文字以内で登録する。（各間の1文字含む）

publisher_address2
string (住所（番地、建物名）) <= 96 characters

番地・建物名を入力
住所（市区町村）と住所（番地、建物名）を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所（市区町村）+住所（番地、建物名）」で合わせて全角100文字以内で登録する。（各間の1文字含む）

publisher_phone
required
string (電話番号) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "publisher_mng_num": "string",
  • "publisher_code": "string",
  • "publisher_company_name": "string",
  • "publisher_section": "string",
  • "publisher_zip": "string",
  • "publisher_area_code": "string",
  • "publisher_address1": "string",
  • "publisher_address2": "string",
  • "publisher_phone": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "publisher_mng_num": "string"
}

発行元削除

  • 概要：発行元（請求元・送付元表示マスタ）の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

publisher_mng_num
required
string (発行元管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "publisher_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

振込先口座

振込先口座取得

  • 概要：登録済みの振込先口座を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

transfer_code
string (振込先コード) <= 15 characters
fncl_inst_code
string (金融機関コード) <= 4 characters
fncl_inst_name
string (金融機関名) <= 15 characters
account_num
string (口座番号) <= 7 characters
bank_reg_flg
integer (常用フラグ) <= 1 characters

常用振込先を取得するか。
0：常用以外
1：常用

sort
integer (取得並び順) <= 1 characters

0：振込先コード（昇順）
1：振込先コード（降順）

start_position
integer (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。 指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。 (例：1を指定→1～100件目、5を指定→5～104件目)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "transfer_code": "string",
  • "fncl_inst_code": "string",
  • "fncl_inst_name": "string",
  • "account_num": "string",
  • "bank_reg_flg": 0,
  • "sort": 0,
  • "start_position": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "bank_list[]": [
    ],
  • "total_count": "string"
}

振込先口座登録

  • 概要：振込先口座の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

transfer_code
string (振込先コード) <= 15 characters
fncl_inst_code
required
string (金融機関コード) <= 4 characters
fncl_inst_name
required
string (金融機関名) <= 15 characters
fncl_inst_kana
required
string (金融機関名カナ) <= 15 characters

半角カナで指定。

branch_code
required
string (支店コード) <= 3 characters
branch_name
required
string (支店名) <= 15 characters
branch_kana
required
string (支店名カナ) <= 15 characters

半角カナで指定。

deposit_sec
required
string (預金種別) <= 1 characters

1：普通預金
2：当座預金
4：貯蓄預金
9：その他

account_num
required
string (口座番号) <= 7 characters
depositor_name
required
string (預金者名) <= 30 characters
depositor_kana
required
string (預金者名カナ) <= 30 characters

半角英数カナで指定。

bank_reg_flg
required
integer (常用フラグ) <= 1 characters

常用振込先に設定するか。
0：常用以外
1：常用

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "transfer_code": "string",
  • "fncl_inst_code": "string",
  • "fncl_inst_name": "string",
  • "fncl_inst_kana": "string",
  • "branch_code": "string",
  • "branch_name": "string",
  • "branch_kana": "string",
  • "deposit_sec": "string",
  • "account_num": "string",
  • "depositor_name": "string",
  • "depositor_kana": "string",
  • "bank_reg_flg": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "bank_num": 0
}

振込先口座更新

  • 概要：振込先口座の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

bank_num
required
integer (口座管理番号) <= 10 characters

口座管理番号が必須。

transfer_code
string (振込先コード) <= 15 characters
fncl_inst_code
required
string (金融機関コード) <= 4 characters
fncl_inst_name
required
string (金融機関名) <= 15 characters
fncl_inst_kana
required
string (金融機関名カナ) <= 15 characters

半角カナで指定。

branch_code
required
string (支店コード) <= 3 characters
branch_name
required
string (支店名) <= 15 characters
branch_kana
required
string (支店名カナ) <= 15 characters

半角カナで指定。

deposit_sec
required
string (預金種別) <= 1 characters

1：普通預金
2：当座預金
4：貯蓄預金
9：その他

account_num
required
string (口座番号) <= 7 characters
depositor_name
required
string (預金者名) <= 30 characters
depositor_kana
required
string (預金者名カナ) <= 30 characters

半角英数カナで指定。

bank_reg_flg
required
integer (常用フラグ) <= 1 characters

常用振込先に設定するか。
0：常用以外
1：常用

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "bank_num": 0,
  • "transfer_code": "string",
  • "fncl_inst_code": "string",
  • "fncl_inst_name": "string",
  • "fncl_inst_kana": "string",
  • "branch_code": "string",
  • "branch_name": "string",
  • "branch_kana": "string",
  • "deposit_sec": "string",
  • "account_num": "string",
  • "depositor_name": "string",
  • "depositor_kana": "string",
  • "bank_reg_flg": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "bank_num": 0
}

振込先口座削除

  • 概要：振込先口座の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

bank_num
required
integer (口座管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "bank_num": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

請求書書式

請求書書式取得

  • 概要：請求書書式情報の詳細データを取得するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string",
  • "invoice_setting_code": "string",
  • "invoice_setting_name": "string",
  • "detail_tax_setting_type": 0,
  • "unit_tax_calc_sec": 0,
  • "tax_free_sec_type": 0,
  • "view_tax_list_flg": 0,
  • "invoice_title": "string",
  • "invoice_amount_title": "string",
  • "amount_diff_makeable_flg": 0,
  • "currency_sign": "string",
  • "cur_disp_pos_sec": 0,
  • "honor": "string",
  • "invoice_comment_flg": 0,
  • "invoice_comment": "string",
  • "default_payment_method": 0,
  • "bank_tnfr_wording_num": 0,
  • "tnfr_fee_wording_num": 0,
  • "drct_dbt_wording_num": 0,
  • "cash_wording_num": 0,
  • "note_wording_num": 0,
  • "creditcard_wording_num": 0,
  • "check_wording_num": 0,
  • "convenience_wording_num": 0,
  • "other_wording_num": 0,
  • "inv_no_str_1": "string",
  • "inv_no_str_2": "string",
  • "inv_no_seq_length": 0,
  • "inv_no_seq_mode": 0,
  • "inv_no_seq_init_value": 0,
  • "tax_free_sec": 0,
  • "tax_rate": 0,
  • "reduced_tax_flg_sec": 0,
  • "tax_round_sec": 0,
  • "inv_free_txt_title1": "string",
  • "inv_free_txt_title2": "string",
  • "inv_free_txt_title3": "string",
  • "inv_free_num_title1": "string",
  • "inv_free_num_title2": "string",
  • "inv_free_num_title3": "string",
  • "inv_free_num_title4": "string",
  • "inv_free_num_title5": "string",
  • "inv_free_num_title6": "string",
  • "inv_free_num_title7": "string",
  • "item_free_txt_title1": "string",
  • "item_free_txt_title2": "string",
  • "item_free_txt_title3": "string",
  • "item_free_txt_title4": "string",
  • "item_free_txt_title5": "string",
  • "item_free_txt_title6": "string",
  • "item_free_txt_title7": "string",
  • "item_free_txt_title8": "string",
  • "item_free_txt_title9": "string",
  • "item_free_txt_title10": "string",
  • "item_free_txt_l_title": "string",
  • "item_prod_code_enable_flg": 0,
  • "item_price_enable_flg": 0,
  • "item_qty_enable_flg": 0,
  • "item_unit_enable_flg": 0,
  • "item_without_tax_enable_flg": 0,
  • "item_tax_enable_flg": 0,
  • "item_slip_date_enable_flg": 0,
  • "item_slip_no_enable_flg": 0,
  • "item_sec_code_enable_flg": 0,
  • "item_sec_name_enable_flg": 0,
  • "detail_remarks_enable_flg": 0,
  • "seller_close_day_list[]": [
    ],
  • "seller_bank_list[]": [
    ],
  • "default_flg": 0,
  • "view_active": 0,
  • "update_name": "string",
  • "update_date": "yyyy-MM-dd"
}

請求書書式画像取得

  • 概要：請求書書式管理番号をキーに会社ロゴと印影の画像データを取得する
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string",
  • "logo": {
    },
  • "stamp": {
    }
}

請求書書式プレビュー取得

  • 概要：請求書書式管理番号をキーに請求書書式のプレビューをPDFで取得する
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string",
  • "layout_pdf": "string"
}

請求書書式一覧取得

  • 概要：請求書書式情報の一覧データを取得するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 200 characters

検索対象：請求書書式設定コード（検索用）、請求書書式設定名称（検索用）を部分一致で取得

invoice_setting_code
string (請求書書式設定コード（検索用）) <= 15 characters

完全一致で取得

invoice_setting_name
string (請求書書式設定名称（検索用）) <= 60 characters

完全一致で取得

view_active
integer (非表示を含めるか) <= 1 characters

0：非表示を含める
1もしくは未指定：非表示を含めない

start_position
string (取得開始位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。 指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。 (例：1を指定→1～100件目、5を指定→5～104件目)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "invoice_setting_code": "string",
  • "invoice_setting_name": "string",
  • "view_active": 0,
  • "start_position": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "layout_list[]": [
    ],
  • "total_count": "string"
}

請求書書式登録

  • 概要：請求書書式情報のデータを登録するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_code
string (請求書書式設定コード) <= 15 characters
invoice_setting_name
required
string (請求書書式設定名称) <= 30 characters
detail_tax_setting_type
required
integer (請求書の保存方式) <= 1 characters

0：請求書等保存方式
1：区分記載請求書等保存方式
2：フリーフォーマット
3：適格請求書等保存方式
4：適格請求書等保存方式（明細ごとに消費税を入力）

unit_tax_calc_sec
required
integer (課税単位) <= 1 characters

0：請求総額
1：明細単位
2：伝票単位
※フリーフォーマット以外は「伝票単位」の指定不可

tax_free_sec_type
required
integer (税区分指定) <= 1 characters

0：指定しない
1：指定する
※フリーフォーマット、請求書等保存方式以外は「指定する」の指定不可

view_tax_list_flg
required
integer (税率ごとに区分した対価の額の表示) <= 1 characters

0：表示しない
1：表示する
※適格請求書等保存方式、区分記載請求書等保存方式は「表示しない」の指定不可
※税区分指定しないは「表示する」の指定不可
※フリーフォーマットかつ請求総額、伝票単位かつ税区分指定するは「表示しない」の指定不可
※請求書等保存方式は「表示する」の指定不可

invoice_title
required
string (請求書タイトル) <= 12 characters
invoice_amount_title
required
string (請求金額タイトル) <= 10 characters
amount_diff_makeable_flg
required
integer (金額相違請求書作成可能フラグ) <= 1 characters

0：作成不可
1：作成可
※適格請求書等保存方式は「作成可」の指定不可

currency_sign
string (通貨記号) <= 5 characters
cur_disp_pos_sec
required
integer (通貨記号表示位置) <= 1 characters

0：前方
1：後方

honor
string (請求先敬称) <= 5 characters
invoice_comment_flg
required
integer (保存方式等の補足文言利用フラグ) <= 1 characters

0：利用しない
1：利用する
※フリーフォーマット、適格請求書等保存方式以外は「利用する」の指定不可

invoice_comment
string (保存方式等の補足文言) <= 50 characters
default_payment_method
required
integer (入金方法の初期設定) <= 1 characters

0：銀行振込
1：口座振替
2：現金
3：手形
4：クレジットカード
5：小切手
6：コンビニ決済
9：その他
指定がない場合は未設定。

bank_tnfr_wording_num
required
integer (銀行振込文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

tnfr_fee_wording_num
required
integer (振込手数料負担文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
7：振込手数料は貴社にてご負担いただきますようお願い申し上げます。
8：誠に恐縮ではございますが、振込手数料は貴社にてご負担いただきますようお願い申し上げます。

drct_dbt_wording_num
required
integer (口座引落文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
4：平素は格別のお引立てを賜り、誠にありがとうございます。上記記載のご請求金額をご指定の口座から振替させていただきます。
5：時下ますますご清栄のことと存じます。上記記載のご請求金額をご指定の口座から振替させていただきます。
6：上記記載のご請求金額をご指定の口座から振替させていただきます。

cash_wording_num
required
integer (現金文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

note_wording_num
required
integer (手形文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

creditcard_wording_num
required
integer (クレジットカード文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

check_wording_num
required
integer (小切手文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

convenience_wording_num
required
integer (コンビニ決済文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

other_wording_num
required
integer (その他文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

inv_no_str_1
string (請求書番号 先頭文字列)

半角英数字で指定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_str_2
string (請求書番号 末尾文字列)

半角英数字で指定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_seq_length
integer (請求書番号 通し番号 桁数) <= 1 characters

0または未指定の場合は、9を設定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_seq_mode
required
integer (請求書番号 通し番号 書式) <= 1 characters

0：「0」埋め(0123)
1：空白埋め(_123)
2：なし(123)

inv_no_seq_init_value
integer (請求書番号 通し番号 初期値) <= 9 characters

未指定の場合は、1を設定。

tax_free_sec
required
integer (消費税計算税区分) <= 1 characters

0：課税
1：非課税
2：免税
3：不課税

tax_rate
required
integer (税率) <= 3 characters
reduced_tax_flg_sec
required
integer (軽減税率フラグ) <= 1 characters

0：通常
1：軽減税率対象

tax_round_sec
required
integer (小数点以下処理) <= 1 characters

0：切捨て
1：切上げ
2：小数第１位四捨五入
3：小数第２位四捨五入

inv_free_txt_title1
string (おもて自由項目（テキスト）タイトル１) <= 8 characters
inv_free_txt_title2
string (おもて自由項目（テキスト）タイトル２) <= 8 characters
inv_free_txt_title3
string (おもて自由項目（テキスト）タイトル３) <= 8 characters
inv_free_num_title1
string (おもて自由項目（数値）タイトル１) <= 8 characters
inv_free_num_title2
string (おもて自由項目（数値）タイトル２) <= 8 characters
inv_free_num_title3
string (おもて自由項目（数値）タイトル３) <= 8 characters
inv_free_num_title4
string (おもて自由項目（数値）タイトル４) <= 8 characters
inv_free_num_title5
string (おもて自由項目（数値）タイトル５) <= 8 characters
inv_free_num_title6
string (おもて自由項目（数値）タイトル６) <= 8 characters
inv_free_num_title7
string (おもて自由項目（数値）タイトル７) <= 8 characters
item_free_txt_title1
string (明細自由項目（テキスト小）タイトル１) <= 10 characters
item_free_txt_title2
string (明細自由項目（テキスト小）タイトル２) <= 10 characters
item_free_txt_title3
string (明細自由項目（テキスト小）タイトル３) <= 10 characters
item_free_txt_title4
string (明細自由項目（テキスト小）タイトル４) <= 10 characters
item_free_txt_title5
string (明細自由項目（テキスト小）タイトル５) <= 10 characters
item_free_txt_title6
string (明細自由項目（テキスト小）タイトル６) <= 10 characters
item_free_txt_title7
string (明細自由項目（テキスト小）タイトル７) <= 10 characters
item_free_txt_title8
string (明細自由項目（テキスト小）タイトル８) <= 10 characters
item_free_txt_title9
string (明細自由項目（テキスト小）タイトル９) <= 10 characters
item_free_txt_title10
string (明細自由項目（テキスト小）タイトル１０) <= 10 characters
item_free_txt_l_title
string (明細自由項目（テキスト大）タイトル) <= 30 characters
item_prod_code_enable_flg
required
integer (明細項目利用設定 - 商品コード) <= 1 characters

0：利用しない
1：利用する

item_price_enable_flg
required
integer (明細項目利用設定 - 単価) <= 1 characters

0：利用しない
1：利用する

item_qty_enable_flg
required
integer (明細項目利用設定 - 数量) <= 1 characters

0：利用しない
1：利用する

item_unit_enable_flg
required
integer (明細項目利用設定 - 単位) <= 1 characters

0：利用しない
1：利用する

item_without_tax_enable_flg
required
integer (明細項目利用設定 - 金額) <= 1 characters

0：利用しない
1：利用する

item_tax_enable_flg
required
integer (明細項目利用設定 - 消費税額) <= 1 characters

0：利用しない
1：利用する

item_slip_date_enable_flg
required
integer (明細項目利用設定 - 明細日付) <= 1 characters

0：利用しない
1：利用する
※適格請求書等保存方式は「利用しない」の指定不可

item_slip_no_enable_flg
required
integer (明細項目利用設定 - 明細番号) <= 1 characters

0：利用しない
1：利用する

item_sec_code_enable_flg
required
integer (明細項目利用設定 - 部門コード) <= 1 characters

0：利用しない
1：利用する

item_sec_name_enable_flg
required
integer (明細項目利用設定 - 部門名) <= 1 characters

0：利用しない
1：利用する

detail_remarks_enable_flg
required
integer (明細項目利用設定 - 備考) <= 1 characters

0：利用しない
1：利用する

Array of objects (締日・入金期限情報リスト)
Array of objects (振込先口座情報リスト)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_code": "string",
  • "invoice_setting_name": "string",
  • "detail_tax_setting_type": 0,
  • "unit_tax_calc_sec": 0,
  • "tax_free_sec_type": 0,
  • "view_tax_list_flg": 0,
  • "invoice_title": "string",
  • "invoice_amount_title": "string",
  • "amount_diff_makeable_flg": 0,
  • "currency_sign": "string",
  • "cur_disp_pos_sec": 0,
  • "honor": "string",
  • "invoice_comment_flg": 0,
  • "invoice_comment": "string",
  • "default_payment_method": 0,
  • "bank_tnfr_wording_num": 0,
  • "tnfr_fee_wording_num": 0,
  • "drct_dbt_wording_num": 0,
  • "cash_wording_num": 0,
  • "note_wording_num": 0,
  • "creditcard_wording_num": 0,
  • "check_wording_num": 0,
  • "convenience_wording_num": 0,
  • "other_wording_num": 0,
  • "inv_no_str_1": "string",
  • "inv_no_str_2": "string",
  • "inv_no_seq_length": 0,
  • "inv_no_seq_mode": 0,
  • "inv_no_seq_init_value": 0,
  • "tax_free_sec": 0,
  • "tax_rate": 0,
  • "reduced_tax_flg_sec": 0,
  • "tax_round_sec": 0,
  • "inv_free_txt_title1": "string",
  • "inv_free_txt_title2": "string",
  • "inv_free_txt_title3": "string",
  • "inv_free_num_title1": "string",
  • "inv_free_num_title2": "string",
  • "inv_free_num_title3": "string",
  • "inv_free_num_title4": "string",
  • "inv_free_num_title5": "string",
  • "inv_free_num_title6": "string",
  • "inv_free_num_title7": "string",
  • "item_free_txt_title1": "string",
  • "item_free_txt_title2": "string",
  • "item_free_txt_title3": "string",
  • "item_free_txt_title4": "string",
  • "item_free_txt_title5": "string",
  • "item_free_txt_title6": "string",
  • "item_free_txt_title7": "string",
  • "item_free_txt_title8": "string",
  • "item_free_txt_title9": "string",
  • "item_free_txt_title10": "string",
  • "item_free_txt_l_title": "string",
  • "item_prod_code_enable_flg": 0,
  • "item_price_enable_flg": 0,
  • "item_qty_enable_flg": 0,
  • "item_unit_enable_flg": 0,
  • "item_without_tax_enable_flg": 0,
  • "item_tax_enable_flg": 0,
  • "item_slip_date_enable_flg": 0,
  • "item_slip_no_enable_flg": 0,
  • "item_sec_code_enable_flg": 0,
  • "item_sec_name_enable_flg": 0,
  • "detail_remarks_enable_flg": 0,
  • "seller_close_day_list[]": [
    ],
  • "seller_bank_list[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string"
}

請求書書式更新

  • 概要：請求書書式情報のデータを更新するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters
invoice_setting_code
string (請求書書式設定コード) <= 15 characters
invoice_setting_name
required
string (請求書書式設定名称) <= 30 characters
detail_tax_setting_type
required
integer (請求書の保存方式) <= 1 characters

0：請求書等保存方式
1：区分記載請求書等保存方式
2：フリーフォーマット
3：適格請求書等保存方式
4：適格請求書等保存方式（明細ごとに消費税を入力）

unit_tax_calc_sec
required
integer (課税単位) <= 1 characters

0：請求総額
1：明細単位
2：伝票単位
※フリーフォーマット以外は「伝票単位」の指定不可

tax_free_sec_type
required
integer (税区分指定) <= 1 characters

0：指定しない
1：指定する
※フリーフォーマット、請求書等保存方式以外は「指定する」の指定不可

view_tax_list_flg
required
integer (税率ごとに区分した対価の額の表示) <= 1 characters

0：表示しない
1：表示する
※適格請求書等保存方式、区分記載請求書等保存方式は「表示しない」の指定不可
※税区分指定しないは「表示する」の指定不可
※フリーフォーマットかつ請求総額、伝票単位かつ税区分指定するは「表示しない」の指定不可
※請求書等保存方式は「表示する」の指定不可

invoice_title
required
string (請求書タイトル) <= 12 characters
invoice_amount_title
required
string (請求金額タイトル) <= 10 characters
amount_diff_makeable_flg
required
integer (金額相違請求書作成可能フラグ) <= 1 characters

0：作成不可
1：作成可
※適格請求書等保存方式は「作成可」の指定不可

currency_sign
string (通貨記号) <= 5 characters
cur_disp_pos_sec
required
integer (通貨記号表示位置) <= 1 characters

0：前方
1：後方

honor
string (請求先敬称) <= 5 characters
invoice_comment_flg
required
integer (保存方式等の補足文言利用フラグ) <= 1 characters

0：利用しない
1：利用する
※フリーフォーマット、適格請求書等保存方式以外は「利用する」の指定不可

invoice_comment
string (保存方式等の補足文言) <= 50 characters
default_payment_method
required
integer (入金方法の初期設定) <= 1 characters

0：銀行振込
1：口座振替
2：現金
3：手形
4：クレジットカード
5：小切手
6：コンビニ決済
9：その他
指定がない場合は未設定。

bank_tnfr_wording_num
required
integer (銀行振込文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

tnfr_fee_wording_num
required
integer (振込手数料負担文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
7：振込手数料は貴社にてご負担いただきますようお願い申し上げます。
8：誠に恐縮ではございますが、振込手数料は貴社にてご負担いただきますようお願い申し上げます。

drct_dbt_wording_num
required
integer (口座引落文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
4：平素は格別のお引立てを賜り、誠にありがとうございます。上記記載のご請求金額をご指定の口座から振替させていただきます。
5：時下ますますご清栄のことと存じます。上記記載のご請求金額をご指定の口座から振替させていただきます。
6：上記記載のご請求金額をご指定の口座から振替させていただきます。

cash_wording_num
required
integer (現金文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

note_wording_num
required
integer (手形文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

creditcard_wording_num
required
integer (クレジットカード文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

check_wording_num
required
integer (小切手文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

convenience_wording_num
required
integer (コンビニ決済文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

other_wording_num
required
integer (その他文言) <= 1 characters

以下のいずれかを指定する。
0：（表示しない）
1：平素は格別のお引立てを賜り、誠にありがとうございます。下記の通りご請求申し上げます。
2：時下ますますご清栄のことと存じます。下記の通りご請求申し上げます。
3：下記の通りご請求申し上げます。

inv_no_str_1
string (請求書番号 先頭文字列) <= 20 characters

半角英数字で指定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_str_2
string (請求書番号 末尾文字列) <= 20 characters

半角英数字で指定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_seq_length
integer (請求書番号 通し番号 桁数) <= 1 characters

0または未指定の場合は、9を設定。
請求書番号は先頭文字列＋通し番号（最大9文字）＋末尾文字列で20文字以内にして指定する。

inv_no_seq_mode
required
integer (請求書番号 通し番号 書式) <= 1 characters

0：「0」埋め(0123)
1：空白埋め(_123)
2：なし(123)

inv_no_seq_init_value
integer (請求書番号 通し番号 初期値) <= 9 characters

未指定の場合は、1を設定。

tax_free_sec
required
integer (消費税計算税区分) <= 1 characters

0：課税
1：非課税
2：免税
3：不課税

tax_rate
required
integer (税率) <= 3 characters
reduced_tax_flg_sec
required
integer (軽減税率フラグ) <= 1 characters

0：通常
1：軽減税率対象

tax_round_sec
required
integer (小数点以下処理) <= 1 characters

0：切捨て
1：切上げ
2：小数第１位四捨五入
3：小数第２位四捨五入

inv_free_txt_title1
string (おもて自由項目（テキスト）タイトル１) <= 8 characters
inv_free_txt_title2
string (おもて自由項目（テキスト）タイトル２) <= 8 characters
inv_free_txt_title3
string (おもて自由項目（テキスト）タイトル３) <= 8 characters
inv_free_num_title1
string (おもて自由項目（数値）タイトル１) <= 8 characters
inv_free_num_title2
string (おもて自由項目（数値）タイトル２) <= 8 characters
inv_free_num_title3
string (おもて自由項目（数値）タイトル３) <= 8 characters
inv_free_num_title4
string (おもて自由項目（数値）タイトル４) <= 8 characters
inv_free_num_title5
string (おもて自由項目（数値）タイトル５) <= 8 characters
inv_free_num_title6
string (おもて自由項目（数値）タイトル６) <= 8 characters
inv_free_num_title7
string (おもて自由項目（数値）タイトル７) <= 8 characters
item_free_txt_title1
string (明細自由項目（テキスト小）タイトル１) <= 10 characters
item_free_txt_title2
string (明細自由項目（テキスト小）タイトル２) <= 10 characters
item_free_txt_title3
string (明細自由項目（テキスト小）タイトル３) <= 10 characters
item_free_txt_title4
string (明細自由項目（テキスト小）タイトル４) <= 10 characters
item_free_txt_title5
string (明細自由項目（テキスト小）タイトル５) <= 10 characters
item_free_txt_title6
string (明細自由項目（テキスト小）タイトル６) <= 10 characters
item_free_txt_title7
string (明細自由項目（テキスト小）タイトル７) <= 10 characters
item_free_txt_title8
string (明細自由項目（テキスト小）タイトル８) <= 10 characters
item_free_txt_title9
string (明細自由項目（テキスト小）タイトル９) <= 10 characters
item_free_txt_title10
string (明細自由項目（テキスト小）タイトル１０) <= 10 characters
item_free_txt_l_title
string (明細自由項目（テキスト大）タイトル) <= 30 characters
item_prod_code_enable_flg
required
integer (明細項目利用設定 - 商品コード) <= 1 characters

0：利用しない
1：利用する

item_price_enable_flg
required
integer (明細項目利用設定 - 単価) <= 1 characters

0：利用しない
1：利用する

item_qty_enable_flg
required
integer (明細項目利用設定 - 数量) <= 1 characters

0：利用しない
1：利用する

item_unit_enable_flg
required
integer (明細項目利用設定 - 単位) <= 1 characters

0：利用しない
1：利用する

item_without_tax_enable_flg
required
integer (明細項目利用設定 - 金額) <= 1 characters

0：利用しない
1：利用する

item_tax_enable_flg
required
integer (明細項目利用設定 - 消費税額) <= 1 characters

0：利用しない
1：利用する

item_slip_date_enable_flg
required
integer (明細項目利用設定 - 明細日付) <= 1 characters

0：利用しない
1：利用する
※適格請求書等保存方式は「利用しない」の指定不可

item_slip_no_enable_flg
required
integer (明細項目利用設定 - 明細番号) <= 1 characters

0：利用しない
1：利用する

item_sec_code_enable_flg
required
integer (明細項目利用設定 - 部門コード) <= 1 characters

0：利用しない
1：利用する

item_sec_name_enable_flg
required
integer (明細項目利用設定 - 部門名) <= 1 characters

0：利用しない
1：利用する

detail_remarks_enable_flg
required
integer (明細項目利用設定 - 備考) <= 1 characters

0：利用しない
1：利用する

Array of objects (締日・入金期限情報リスト)
Array of objects (振込先口座情報リスト)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0,
  • "invoice_setting_code": "string",
  • "invoice_setting_name": "string",
  • "detail_tax_setting_type": 0,
  • "unit_tax_calc_sec": 0,
  • "tax_free_sec_type": 0,
  • "view_tax_list_flg": 0,
  • "invoice_title": "string",
  • "invoice_amount_title": "string",
  • "amount_diff_makeable_flg": 0,
  • "currency_sign": "string",
  • "cur_disp_pos_sec": 0,
  • "honor": "string",
  • "invoice_comment_flg": 0,
  • "invoice_comment": "string",
  • "default_payment_method": 0,
  • "bank_tnfr_wording_num": 0,
  • "tnfr_fee_wording_num": 0,
  • "drct_dbt_wording_num": 0,
  • "cash_wording_num": 0,
  • "note_wording_num": 0,
  • "creditcard_wording_num": 0,
  • "check_wording_num": 0,
  • "convenience_wording_num": 0,
  • "other_wording_num": 0,
  • "inv_no_str_1": "string",
  • "inv_no_str_2": "string",
  • "inv_no_seq_length": 0,
  • "inv_no_seq_mode": 0,
  • "inv_no_seq_init_value": 0,
  • "tax_free_sec": 0,
  • "tax_rate": 0,
  • "reduced_tax_flg_sec": 0,
  • "tax_round_sec": 0,
  • "inv_free_txt_title1": "string",
  • "inv_free_txt_title2": "string",
  • "inv_free_txt_title3": "string",
  • "inv_free_num_title1": "string",
  • "inv_free_num_title2": "string",
  • "inv_free_num_title3": "string",
  • "inv_free_num_title4": "string",
  • "inv_free_num_title5": "string",
  • "inv_free_num_title6": "string",
  • "inv_free_num_title7": "string",
  • "item_free_txt_title1": "string",
  • "item_free_txt_title2": "string",
  • "item_free_txt_title3": "string",
  • "item_free_txt_title4": "string",
  • "item_free_txt_title5": "string",
  • "item_free_txt_title6": "string",
  • "item_free_txt_title7": "string",
  • "item_free_txt_title8": "string",
  • "item_free_txt_title9": "string",
  • "item_free_txt_title10": "string",
  • "item_free_txt_l_title": "string",
  • "item_prod_code_enable_flg": 0,
  • "item_price_enable_flg": 0,
  • "item_qty_enable_flg": 0,
  • "item_unit_enable_flg": 0,
  • "item_without_tax_enable_flg": 0,
  • "item_tax_enable_flg": 0,
  • "item_slip_date_enable_flg": 0,
  • "item_slip_no_enable_flg": 0,
  • "item_sec_code_enable_flg": 0,
  • "item_sec_name_enable_flg": 0,
  • "detail_remarks_enable_flg": 0,
  • "seller_close_day_list[]": [
    ],
  • "seller_bank_list[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string"
}

請求書書式非表示設定

  • 概要：請求書書式を既定設定するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters
view_active
integer (表示／非表示フラグ) <= 1 characters

0：非表示
1または未指定：表示

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0,
  • "view_active": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string"
}

請求書書式画像設定

  • 概要：既存の請求書書式に対し、会社ロゴと印影の画像データを登録するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_meg_num
required
integer (請求書書式設定管理番号) <= 10 characters
object (会社ロゴ情報)
object (印影情報)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_meg_num": 0,
  • "logo": {
    },
  • "stamp": {
    }
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_meg_num": "string"
}

請求書書式既定設定

  • 概要：請求書書式を既定設定するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_setting_mng_num
required
integer (請求書書式設定管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_setting_mng_num": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_setting_mng_num": "string"
}

受取請求書

請求書PDF・添付ファイル取得

  • 概要：指定した請求書のPDF及び添付ファイルを取得する。

  • 処理詳細：
    １．API実行権限チェック
    API利用ユーザーが有料会員かチェックを行う。
    受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbidden」を返却する。

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

    ３．請求書情報の取得処理
    リクエストに該当する請求書のPDF及び添付ファイルを取得する。

    ４．取得結果送信
    処理結果をJSON/XML形式で返却する。

  • 備考・補足： 請求書PDF取得時に対象請求書の明細件数またはカスタム明細件数が1,000件を超えて場合
    該当する情報のPDFは印刷されずエラー情報に警告メッセージが出力される。

    ※本APIのみ、URL、インターフェースバージョンがv1のものとなります。

Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"json"
"xml"

invoice_mng_num
required
number (請求書管理番号) <= 10 characters

BtoB PF請求書システムで請求書を一意に識別するキー
請求書管理番号は請求データ取得APIで取得が可能。

invoice_pdf_get_flg
number (請求書PDF取得) <= 1 characters

請求書PDFを取得するか
0:取得しない
1:取得する

attached_file_get_flg
number (添付ファイル取得) <= 1 characters

請求書に添付されているファイルを取得するか
0:取得しない
1:取得する

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_mng_num": 0,
  • "invoice_pdf_get_flg": 0,
  • "attached_file_get_flg": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_pdf": {
    },
  • "seller_attached_file[]": [
    ]
}

請求データ取得

  • 概要：受取側システムに取り込む請求データと仕訳データを取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

reception_date_from
required
string <date-time> (受取日(From)) <= 19 characters

「yyyy-MM-dd HH：mm：ss(JST)」の形式で指定する。
日付指定のみの場合は、「yyyy-MM-dd 00：00：00(JST)」でセットされる。

reception_date_to
required
string <date-time> (受取日(To)) <= 19 characters

「yyyy-MM-dd HH：mm：ss(JST)」の形式で指定する。
日付指定のみの場合は、「yyyy-MM-dd 23：59：59(JST)」でセットされる。

final_approval_date_from
string <date> (最終経理承認日(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

final_approval_date_to
string <date> (最終経理承認日(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_from_b
string <date> (自社支払期限(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_to_b
string <date> (自社支払期限(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_from
string <date> (支払期限(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_to
string <date> (支払期限(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

close_date_from
string <date> (締日(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

close_date_to
string <date> (締日(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

payment_method
string (支払方法) <= 1 characters

0：銀行振込
1：口座振替
2：現金
3：手形
4：クレジットカード
5：小切手
6：コンビニ決済
9：その他

acc_code
string (勘定科目コード) <= 15 characters
burden_sec_code
string (負担部門コード) <= 15 characters
slip_date_from
string <date> (明細日付(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

slip_date_to
string <date> (明細日付(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

account_date_from
string <date> (会計伝票日付(From)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

account_date_to
string <date> (会計伝票日付(To)) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

inv_amount_from
string (請求金額(From)) <= 13 characters

整数部13桁まで

inv_amount_to
string (請求金額(To)) <= 13 characters

整数部13桁まで

invoice_type
string (保存方式) <= 1 characters

0：請求書等保存方式
1：区分記載請求書等保存方式
2：フリーフォーマット
3：適格請求書等保存方式

unit_tax_calc_sec
string (課税単位) <= 1 characters

0または未指定：すべて
1：請求総額
2：明細単位
3：伝票単位

biz_type
string (事業者区分) <= 1 characters

空白：全て
1：課税事業者
2：免税事業者

extracting_type01
string (抽出種別(要対応)) <= 1 characters

発行側企業より発行され、対応が必要な請求書を抽出するか。
0：未設定
1：抽出する

extracting_type02
string (抽出種別(新規)) <= 1 characters

新規取引先の請求書を抽出するか。
0：未設定
1：抽出する

extracting_type03
string (抽出種別(差戻し)) <= 1 characters

①社内承認フローの依頼が差戻しされた場合
②経理承認フローの依頼が差戻しされた場合
上記のいずれかの請求書を抽出するか。
0：未設定
1：抽出する

extracting_type04
string (抽出種別(未設定)) <= 1 characters

①銀行振込で振込先口座が未選択の場合
②未仕訳の場合
上記のいずれかの請求書を抽出するか。
0：未設定
1：抽出する

extracting_type05
string (抽出種別(自社作成)) <= 1 characters

自社作成の請求書を抽出するか。
0：未設定
1：抽出する

extracting_type06
string (抽出種別(自動取込)) <= 1 characters

自動取込された請求書を抽出するか。
0：未設定
1：抽出する

extracting_type07
string (抽出種別(回答あり)) <= 1 characters

質問回答のある請求書を抽出するか。
0：未設定
1：抽出する

extracting_type08
string (抽出種別(質問あり)) <= 1 characters

質問のある請求書を抽出するか。
0：未設定
1：抽出する

extracting_type09
string (抽出種別(質問中)) <= 1 characters

質問中の請求書を抽出するか。
0：未設定
1：抽出する

seal_flg
string (請求データ開封フラグ) <= 1 characters

0または未指定：すべて
1：開封済みのみ
2：未開封のみ

output_jounals_flg
string (仕訳情報取得フラグ) <= 1 characters

0または未指定：仕訳情報を出力しない。
1：仕訳情報を出力する。(すべての情報)

account_dl_flg
string (会計ダウンロード済み設定フラグ) <= 1 characters

0または未指定：API実施時に会計ダウロード済みフラグを設定しない。
1：API実施時に会計ダウンロード済みフラグを設定する。

account_dl
string (会計ダウンロードフラグ) <= 1 characters

0または未指定：すべて
1：会計ダウンロード済みのみ。
2：会計ダウンロード未実施のみ。

payment_dl
string (支払ダウンロードフラグ) <= 1 characters

0または未指定：すべて
1：支払ダウンロード済みのみ。
2：支払ダウンロード未実施のみ。

wf_status
Array of objects (ワークフローステータス)

配列で指定。
配列内は半角数字2桁。
例）wf_status[50,51,59,60,69,70,71]

ワークフローを利用する場合
19：取引先差戻
50：一次未承認
51：社内承認中
59：差戻受
60：経理承認中
69：経理差戻受
70：最終経理承認中
71：最終経理承認完了

ワークフローを利用しない場合
19：取引先差戻
50：未処理
71：処理済

processing_user_code
string (処理中担当者社員コード) <= 15 characters
processing_user_login_id
string (処理中担当者プラットフォームID) <= 100 characters
processing_group_code
string (処理中グループコード) <= 10 characters
recent_processed_user_code
string (直近の処理担当者社員コード) <= 15 characters
recent_processed_user_login_id
string (直近の処理担当者プラットフォームID) <= 100 characters
keyword
string (キーワード) <= 200 characters

検索対象：支払先、支払先コード、明細項目、明細番号、処理中担当者、承認者、件名、メモ1、メモ2、請求書番号、請求書管理コードを部分一致で取得

invoice_mng_num
string (請求書管理番号) <= 10 characters

完全一致で取得

company_name_s
string (支払先（検索用）) <= 200 characters

完全一致で取得

private_cust_cd_s
string (支払先コード（検索用）) <= 15 characters

完全一致で取得

item_name
string (明細項目（検索用）) <= 100 characters

完全一致で取得

item_slip_no
string (明細番号（検索用）) <= 20 characters

完全一致で取得

processing_user_name
string (処理中担当者（検索用）) <= 80 characters

完全一致で取得

acc_depart_name
string (承認者（検索用）) <= 80 characters

完全一致で取得

inv_name
string (件名（検索用）) <= 80 characters

完全一致で取得

memo1
string (メモ1（検索用）) <= 200 characters

完全一致で取得

memo2
string (メモ2（検索用）) <= 200 characters

完全一致で取得

inv_no
string (請求書番号（検索用）) <= 20 characters

完全一致で取得

invoice_mng_code
string (請求書管理コード（検索用）) <= 200 characters

完全一致で取得

sort
string (並び順) <= 1 characters

0または未指定：受取日(降順)
1：受取日(昇順)
2：自社支払期限(降順)
3：自社支払期限(昇順)
4：請求金額(降順)
5：請求金額(昇順)
6：支払先コード(降順)
7：支払先コード(昇順)

start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、取得件数で指定した件数を返却する。（指定が無い場合は指定位置から100件を返却）

get_count
string (取得件数) <= 2 characters

指定がない場合は100件を返却。
1~99の範囲で数値を指定し、指定された件数のデータを返却。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "reception_date_from": "yyyy-MM-dd HH：mm：ss",
  • "reception_date_to": "yyyy-MM-dd HH：mm：ss",
  • "final_approval_date_from": "yyyy-MM-dd",
  • "final_approval_date_to": "yyyy-MM-dd",
  • "pay_due_date_from_b": "yyyy-MM-dd",
  • "pay_due_date_to_b": "yyyy-MM-dd",
  • "pay_due_date_from": "yyyy-MM-dd",
  • "pay_due_date_to": "yyyy-MM-dd",
  • "close_date_from": "yyyy-MM-dd",
  • "close_date_to": "yyyy-MM-dd",
  • "payment_method": "string",
  • "acc_code": "string",
  • "burden_sec_code": "string",
  • "slip_date_from": "yyyy-MM-dd",
  • "slip_date_to": "yyyy-MM-dd",
  • "account_date_from": "yyyy-MM-dd",
  • "account_date_to": "yyyy-MM-dd",
  • "inv_amount_from": "string",
  • "inv_amount_to": "string",
  • "invoice_type": "string",
  • "unit_tax_calc_sec": "string",
  • "biz_type": "string",
  • "extracting_type01": "string",
  • "extracting_type02": "string",
  • "extracting_type03": "string",
  • "extracting_type04": "string",
  • "extracting_type05": "string",
  • "extracting_type06": "string",
  • "extracting_type07": "string",
  • "extracting_type08": "string",
  • "extracting_type09": "string",
  • "seal_flg": "string",
  • "output_jounals_flg": "string",
  • "account_dl_flg": "string",
  • "account_dl": "string",
  • "payment_dl": "string",
  • "wf_status": [
    ],
  • "processing_user_code": "string",
  • "processing_user_login_id": "string",
  • "processing_group_code": "string",
  • "recent_processed_user_code": "string",
  • "recent_processed_user_login_id": "string",
  • "keyword": "string",
  • "invoice_mng_num": "string",
  • "company_name_s": "string",
  • "private_cust_cd_s": "string",
  • "item_name": "string",
  • "item_slip_no": "string",
  • "processing_user_name": "string",
  • "acc_depart_name": "string",
  • "inv_name": "string",
  • "memo1": "string",
  • "memo2": "string",
  • "inv_no": "string",
  • "invoice_mng_code": "string",
  • "sort": "string",
  • "start_position": "string",
  • "get_count": "string"
}

Response samples

Content type
Example
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invdata[]": [
    ],
  • "total_count": "string"
}

請求書処理済み

  • 概要：受け取った請求書を処理済みにする。
  • 備考・補足： 処理済みにすると、取引先への差戻や、負担部門や勘定科目を変更することができなくなります。
    承認フローご利用中の場合は本APIを利用できません。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_mng_num
required
string (請求書管理番号) <= 10 characters

BtoB PF請求書システムで請求書を一意に識別するキー

pay_due_date_b
string <date> (自社支払期限) <= 10 characters

yyyy-MM-dd (JST)の形式で指定

自社支払期限が設定されていない場合は必須、設定されていれば空白可。

user_login_id
required
string (担当者プラットフォームID) <= 100 characters

半角英数字100文字以内、処理済みに更新する担当者のプラットフォームID（メールアドレス）を指定

※請求書の宛先に指定している、受取担当者のプラットフォームID（メールアドレス）を指定してください
※請求書の宛先に、承認グループを指定している場合は、グループに含まれる担当者のプラットフォームID（メールアドレス）を指定してください

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_mng_num": "string",
  • "pay_due_date_b": "yyyy-MM-dd",
  • "user_login_id": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_mng_num": "string"
}

請求書差戻し

  • 概要：受け取った請求書に対して、取引先へ差戻処理を行う。
  • 備考・補足： 本APIは、取引先への差戻に対応するAPIになります。社内への差戻には対応しておりません。
    承認フローご利用中の場合は本APIを利用できません。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_mng_num
required
string (請求書管理番号) <= 10 characters

BtoB PF請求書システムで請求書を一意に識別するキー

memo
required
string (メッセージ) <= 1500 characters
user_login_id
required
string (担当者プラットフォームID) <= 100 characters

半角英数字100文字以内、処理済みに更新する担当者のプラットフォームID（メールアドレス）を指定 ※請求書の宛先に指定している、受取担当者のプラットフォームID（メールアドレス）を指定してください ※請求書の宛先に、承認グループを指定している場合は、グループに含まれる担当者のプラットフォームID（メールアドレス）を指定してください

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_mng_num": "string",
  • "memo": "string",
  • "user_login_id": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "invoice_mng_num": "string"
}

支払先

支払先取得

  • 概要：登録済みの支払先情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invite_status
string (招待履歴) <= 1 characters

0または未指定：全て
1：未招待
2：招待済
※招待履歴と招待先のログイン状況フラグの組み合わせに関する補足はAppendixの「招待履歴」と「招待先のログイン状況」フラグの組み合わせを参照。

login_flg
string (招待先のログイン状況) <= 1 characters

0または未指定：全て
1：ログイン済
2：未ログイン

※招待履歴が「1：未招待」かつ、「1：ログイン済」を指定した場合は、パターンが無いためデータの取得は行えない。
※招待履歴と招待先のログイン状況フラグの組み合わせに関する補足はAppendixの「招待履歴」と「招待先のログイン状況」フラグの組み合わせを参照。

update_date_from
string <date> (更新日（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

update_date_to
string <date> (更新日（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定。

view_active
string (非表示設定) <= 1 characters

0または未指定：表示のみ
1：非表示のみ

private_user_id
string (受取担当者PFID) <= 100 characters

プラットフォームIDを指定

biz_type
string (事業者区分) <= 1 characters

未指定：全て
0：未設定
1：課税事業者
2：免税事業者

biz_regist_no
string (事業者登録番号) <= 1 characters

0または未指定：全て
1：登録あり
2：登録なし

biz_diff_check_flg
string (事業者登録番号差異) <= 1 characters

0または未指定：全て
1：差異あり
2：差異あり（確認済みは除外する）
3：差異なし

keyword
string (キーワード) <= 200 characters

事業所・営業所名、発行先担当者名、メールアドレス、支払先コードから部分一致で取得

customer_mng_num
string (支払先管理番号) <= 13 characters

完全一致で取得
NI_9999999999／CM_9999999999の形式で指定

company_name_org
string (事業所・営業所) <= 200 characters

完全一致で取得

private_user_name
string (支払先担当者) <= 200 characters

完全一致で取得

user_email
string (メールアドレス) <= 200 characters

完全一致で取得

private_cust_cd
string (支払先コード) <= 15 characters

完全一致で取得

start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、指定位置から最大100件を返却する。

sort
string (並び順) <= 1 characters

0または空白：企業名(昇順)
1：企業名(降順)
2：支払先コード(昇順)
3：支払先コード(降順)
4：更新日(昇順)
5：更新日(降順)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invite_status": "string",
  • "login_flg": "string",
  • "update_date_from": "yyyy-MM-dd",
  • "update_date_to": "yyyy-MM-dd",
  • "view_active": "string",
  • "private_user_id": "string",
  • "biz_type": "string",
  • "biz_regist_no": "string",
  • "biz_diff_check_flg": "string",
  • "keyword": "string",
  • "customer_mng_num": "string",
  • "company_name_org": "string",
  • "private_user_name": "string",
  • "user_email": "string",
  • "private_cust_cd": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customers[]": [
    ],
  • "journals": [
    ],
  • "inv_last_reception_date": "string",
  • "inv_remind_date": "string",
  • "close_day": [ ],
  • "no_later_than_date_send_date": "string",
  • "no_later_than_date": "string",
  • "comp_corp_genuine_id": "string",
  • "update_date": "yyyy-MM-dd",
  • "cust_user_login_date": "yyyy-MM-dd",
  • "company_name": "string",
  • "external_data_flg": "string",
  • "external_data_name": "string",
  • "mail_err_flg": "string",
  • "account_lock_flg": "string",
  • "retirement_flg": "string",
  • "coop_post_use_flg": "string",
  • "coop_post_type": "string",
  • "coop_post_use_invite_flg": "string",
  • "coop_post_use_invite_pay_flg": "string",
  • "coop_post_ad_flg": "string",
  • "payment_setting_mng_num": "string",
  • "payment_setting_code": "string",
  • "payment_setting_name": "string",
  • "destination_mng_num": "string",
  • "inv_flg": "string",
  • "last_invite_date": "string",
  • "last_invite_method": "string",
  • "invite_possible_method": "string",
  • "publisher_biz_type": "string",
  • "biz_type_update_date": "string",
  • "publisher_biz_regist_no": "string",
  • "biz_regist_no_update_date": "string",
  • "publisher_nta_biz_regist_no_result": "string",
  • "publisher_nta_registered_date": "string",
  • "publisher_nta_process": "string",
  • "publisher_nta_company_name": "string",
  • "publisher_nta_area": "string",
  • "publisher_nta_address": "string",
  • "publisher_nta_update_date": "string",
  • "publisher_nta_trade_name": "string",
  • "publisher_nta_common_name": "string",
  • "publisher_nta_cancel_date": "string",
  • "publisher_nta_lapse_date": "string",
  • "customer_biz_type": "string",
  • "customer_biz_regist_no": "string",
  • "customerr_nta_biz_regist_no_result": "string",
  • "customer_nta_registered_date": "string",
  • "customer_nta_process": "string",
  • "customer_nta_company_name": "string",
  • "customer_nta_area": "string",
  • "customer_nta_address": "string",
  • "customer_nta_update_date": "string",
  • "customer_nta_trade_name": "string",
  • "customer_nta_common_name": "string",
  • "customer_nta_cancel_date": "string",
  • "customer_nta_lapse_date": "string",
  • "biz_type_diff": "string",
  • "biz_regist_no_diff": "string",
  • "biz_diff_check_flg": "string",
  • "total_count": "string"
}

支払先登録

  • 概要：支払先の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

private_cust_cd
string (支払先コード) <= 15 characters
user_mail
string (メールアドレス) <= 100 characters

メールアドレスは半角100文字以内

user_name_sei
string (氏) <= 15 characters

氏は全角15文字以内

user_name_mei
string (名) <= 15 characters

名は全角15文字以内

user_name_sei_kana
string (氏カナ) <= 20 characters
user_name_mei_kana
string (名カナ) <= 20 characters
corp_geniuine_id
string (法人番号) <= 13 characters
company_name_org
required
string (企業名) <= 60 characters

会社名は法人格、事業所・営業所名とあわせて全角30文字以内、半角60文字以内

company_name_kana_org
string (企業名(カナ)) <= 100 characters

会社名（カナ）は事業所・営業所名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

base_name
string (事業所・営業署名) <= 60 characters

事業所・営業所名は法人格、会社名とあわせて全角30文字以内、半角60文字以内

base_name_kana
string (事業所・営業署名(カナ)) <= 100 characters

事業所・営業所名（カナ）は会社名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1(市区町村)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2(番地、建物名等)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

phone
string (TEL) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

private_user_id
required
string (受取担当者PFID) <= 100 characters

自社担当者のプラットフォームIDを指定

trfr_fee_bud_sec
string (振込手数料負担種別) <= 1 characters

0：自社負担
1：取引先負担

object (振込先口座(自社設定))
auto_refrect_flg
string (自動反映設定フラグ) <= 1 characters

0：自動反映しない
1：自動反映する
2：初期設定を使用する

auto_refrect_item
Array of objects (自動反映項目)

自動反映設定フラグを「自動反映する」場合に必須となる。
指定例）["1","32","128"]

1：法人番号
2：会社名
4：会社名（カナ）
8：事業所・営業所名
16：事業所・営業所名（カナ）
32：電話番号
64：FAX番号
128：郵便番号
256：住所

coop_post_use_flg
string (郵送代行サービス利用区分（通知書）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_type
string (郵送請求書/通知書タイプ) <= 1 characters

0：初期設定を利用する
4：はがき4面
5：封書(明細のみ)
6：封書(カスタム明細のみ)
7：封書(明細＋カスタム明細)
8：はがき6面
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_flg
string (郵送代行サービス利用区分(請求書招待)) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_pay_flg
string (郵送代行サービス利用区分(通知書招待)) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

destination_mng_num
string (宛先管理番号) <= 10 characters
Array of objects (締日(配列))
send_flg
string (案内送信) <= 1 characters

0：送信しない
1：送信する
2：初期設定を使用する

send_date
string (案内送信日) <= 2 characters

案内送信日を指定する。
1～15 ※画面：請求書締日の1~15日前に送信する

no_later_than_date
string (必着日) <= 2 characters

必着日を指定する。
1～15 ※画面： 請求書締日の1~15日後を必着日として案内する

debit_bur_sec_mng_type
string (借方負担部門管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_bur_sec_mng_num
string (借方負担部門管理番号) <= 10 characters
debit_acc_mng_type
string (借方勘定科目管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_acc_mng_num
string (借方勘定科目管理番号) <= 10 characters
debit_spcrs_mng_type
string (借方補助科目管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_spcrs_mng_num
string (借方補助科目管理番号) <= 10 characters
credit_bur_sec_mng_type
string (貸方負担部門管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_bur_sec_mng_num
string (貸方負担部門管理番号) <= 10 characters
credit_acc_mng_type
string (貸方勘定科目管理種別) <= 10 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_acc_mng_num
string (貸方勘定科目管理番号) <= 10 characters
credit_spcrs_mng_type
string (貸方補助科目管理種別) <= 10 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_spcrs_mng_num
string (貸方補助科目管理番号) <= 10 characters
biz_type
string (事業者区分) <= 1 characters

0：未設定
1：課税事業者
2：免税事業者

biz_regist_no
string (事業者登録番号) <= 14 characters

T0000000000000の形式

jnl_spcrs_mng_type1
string (仕訳補助項目管理種別１) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num1
string (仕訳補助項目管理番号１) <= 10 characters
jnl_spcrs_mng_type2
string (仕訳補助項目管理種別２) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num2
string (仕訳補助項目管理番号２) <= 10 characters
jnl_spcrs_mng_type3
string (仕訳補助項目管理種別３) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num3
string (仕訳補助項目管理番号３) <= 10 characters
jnl_spcrs_mng_type4
string (仕訳補助項目管理種別４) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num4
string (仕訳補助項目管理番号４) <= 10 characters
jnl_spcrs_mng_type5
string (仕訳補助項目管理種別５) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num5
string (仕訳補助項目管理番号５) <= 10 characters
jnl_spcrs_mng_type6
string (仕訳補助項目管理種別６) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num6
string (仕訳補助項目管理番号６) <= 10 characters
jnl_spcrs_mng_type7
string (仕訳補助項目管理種別７) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num7
string (仕訳補助項目管理番号７) <= 10 characters
jnl_spcrs_mng_type8
string (仕訳補助項目管理種別８) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num8
string (仕訳補助項目管理番号８) <= 10 characters
jnl_spcrs_mng_type9
string (仕訳補助項目管理種別９) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt9
string (仕訳自由項目９) <= 200 characters

仕訳補助項目管理種別９の入力内容を指定する。

jnl_spcrs_mng_type10
string (仕訳補助項目管理種別１０) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt10
string (仕訳自由項目１０) <= 200 characters

仕訳補助項目管理種別１０の入力内容を指定する。

jnl_spcrs_mng_type11
string (仕訳補助項目管理種別１１) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt11
string (仕訳自由項目１１) <= 200 characters

仕訳補助項目管理種別１１の入力内容を指定する。

jnl_spcrs_mng_type12
string (仕訳補助項目管理種別１２) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt12
string (仕訳自由項目１２) <= 200 characters

仕訳補助項目管理種別１２の入力内容を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "private_cust_cd": "string",
  • "user_mail": "string",
  • "user_name_sei": "string",
  • "user_name_mei": "string",
  • "user_name_sei_kana": "string",
  • "user_name_mei_kana": "string",
  • "corp_geniuine_id": "string",
  • "company_name_org": "string",
  • "company_name_kana_org": "string",
  • "base_name": "string",
  • "base_name_kana": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "phone": "string",
  • "fax": "string",
  • "private_user_id": "string",
  • "trfr_fee_bud_sec": "string",
  • "cust_private_bank": {
    },
  • "auto_refrect_flg": "string",
  • "auto_refrect_item": [
    ],
  • "coop_post_use_flg": "string",
  • "coop_post_type": "string",
  • "coop_post_use_invite_flg": "string",
  • "coop_post_use_invite_pay_flg": "string",
  • "destination_mng_num": "string",
  • "closing_days[]": [
    ],
  • "send_flg": "string",
  • "send_date": "string",
  • "no_later_than_date": "string",
  • "debit_bur_sec_mng_type": "string",
  • "debit_bur_sec_mng_num": "string",
  • "debit_acc_mng_type": "string",
  • "debit_acc_mng_num": "string",
  • "debit_spcrs_mng_type": "string",
  • "debit_spcrs_mng_num": "string",
  • "credit_bur_sec_mng_type": "string",
  • "credit_bur_sec_mng_num": "string",
  • "credit_acc_mng_type": "string",
  • "credit_acc_mng_num": "string",
  • "credit_spcrs_mng_type": "string",
  • "credit_spcrs_mng_num": "string",
  • "biz_type": "string",
  • "biz_regist_no": "string",
  • "jnl_spcrs_mng_type1": "string",
  • "jnl_spcrs_mng_num1": "string",
  • "jnl_spcrs_mng_type2": "string",
  • "jnl_spcrs_mng_num2": "string",
  • "jnl_spcrs_mng_type3": "string",
  • "jnl_spcrs_mng_num3": "string",
  • "jnl_spcrs_mng_type4": "string",
  • "jnl_spcrs_mng_num4": "string",
  • "jnl_spcrs_mng_type5": "string",
  • "jnl_spcrs_mng_num5": "string",
  • "jnl_spcrs_mng_type6": "string",
  • "jnl_spcrs_mng_num6": "string",
  • "jnl_spcrs_mng_type7": "string",
  • "jnl_spcrs_mng_num7": "string",
  • "jnl_spcrs_mng_type8": "string",
  • "jnl_spcrs_mng_num8": "string",
  • "jnl_spcrs_mng_type9": "string",
  • "jnl_free_txt9": "string",
  • "jnl_spcrs_mng_type10": "string",
  • "jnl_free_txt10": "string",
  • "jnl_spcrs_mng_type11": "string",
  • "jnl_free_txt11": "string",
  • "jnl_spcrs_mng_type12": "string",
  • "jnl_free_txt12": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

支払先更新

  • 概要：支払先情報の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

customer_mng_num
required
string (支払先管理番号) <= 13 characters

番号の先頭に以下の文字列を付与して指定。
未招待の場合：NI_
招待済みの場合：CM_

private_cust_cd
string (支払先コード) <= 15 characters
user_mail
string (メールアドレス) <= 100 characters

メールアドレスは半角100文字以内

user_name_sei
string (氏) <= 15 characters

氏は全角15文字以内

user_name_mei
string (名) <= 15 characters

名は全角15文字以内

user_name_sei_kana
string (氏カナ) <= 20 characters
user_name_mei_kana
string (名カナ) <= 20 characters
corp_geniuine_id
string (法人番号) <= 13 characters
company_name_org
required
string (企業名) <= 60 characters

会社名は法人格、事業所・営業所名とあわせて全角30文字以内、半角60文字以内

company_name_kana_org
string (企業名(カナ)) <= 100 characters

会社名（カナ）は事業所・営業所名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

base_name
string (事業所・営業署名) <= 60 characters

事業所・営業所名は法人格、会社名とあわせて全角30文字以内、半角60文字以内

base_name_kana
string (事業所・営業署名(カナ)) <= 100 characters

事業所・営業所名（カナ）は会社名（カナ）とあわせて全角カナ50文字以内、半角カナ100文字以内

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1(市区町村)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2(番地、建物名等)) <= 97 characters

住所1と住所2を合わせて、全角97文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

phone
string (TEL) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX) <= 15 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

private_user_id
required
string (受取担当者PFID) <= 100 characters

自社担当者のプラットフォームIDを指定

trfr_fee_bud_sec
string (振込手数料負担種別) <= 1 characters

0：自社負担
1：取引先負担

object (振込先口座(自社設定))
auto_refrect_flg
string (自動反映設定フラグ) <= 1 characters

0：自動反映しない
1：自動反映する
2：初期設定を使用する

auto_refrect_item
Array of objects (自動反映項目)

自動反映設定フラグを「自動反映する」場合に必須となる。
指定例）["1","32","128"]

1：法人番号
2：会社名
4：会社名（カナ）
8：事業所・営業所名
16：事業所・営業所名（カナ）
32：電話番号
64：FAX番号
128：郵便番号
256：住所

coop_post_use_flg
string (郵送代行サービス利用区分（通知書）) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_type
string (郵送請求書/通知書タイプ) <= 1 characters

0：初期設定を利用する
4：はがき4面
5：封書(明細のみ)
6：封書(カスタム明細のみ)
7：封書(明細＋カスタム明細)
8：はがき6面
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_flg
string (郵送代行サービス利用区分(請求書招待)) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

coop_post_use_invite_pay_flg
string (郵送代行サービス利用区分(通知書招待)) <= 1 characters

0：初期設定を利用する
1：利用しない
2：利用する
※郵送代行オプションを利用している場合のみ設定可能

destination_mng_num
string (宛先管理番号) <= 10 characters
object (締日(配列))
send_flg
string (案内送信) <= 1 characters

0：送信しない
1：送信する
2：初期設定を使用する

send_date
string (案内送信日) <= 2 characters

案内送信日を指定する。
1～15 ※画面：請求書締日の1~15日前に送信する

no_later_than_date
string (必着日) <= 2 characters

必着日を指定する。
1～15 ※画面： 請求書締日の1~15日後を必着日として案内する

debit_bur_sec_mng_type
string (借方負担部門管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_bur_sec_mng_num
string (借方負担部門管理番号) <= 10 characters
debit_acc_mng_type
string (借方勘定科目管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_acc_mng_num
string (借方勘定科目管理番号) <= 10 characters
debit_spcrs_mng_type
string (借方補助科目管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

debit_spcrs_mng_num
string (借方補助科目管理番号) <= 10 characters
credit_bur_sec_mng_type
string (貸方負担部門管理種別) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_bur_sec_mng_num
string (貸方負担部門管理番号) <= 10 characters
credit_acc_mng_type
string (貸方勘定科目管理種別) <= 10 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_acc_mng_num
string (貸方勘定科目管理番号) <= 10 characters
credit_spcrs_mng_type
string (貸方補助科目管理種別) <= 10 characters

0：学習機能を利用
1：未設定
2：マスタ設定

credit_spcrs_mng_num
string (貸方補助科目管理番号) <= 10 characters
biz_type
string (事業者区分) <= 1 characters

0：未設定
1：課税事業者
2：免税事業者

biz_regist_no
string (事業者登録番号) <= 14 characters

T0000000000000の形式

jnl_spcrs_mng_type1
string (仕訳補助項目管理種別１) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num1
string (仕訳補助項目管理番号１) <= 10 characters
jnl_spcrs_mng_type2
string (仕訳補助項目管理種別２) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num2
string (仕訳補助項目管理番号２) <= 10 characters
jnl_spcrs_mng_type3
string (仕訳補助項目管理種別３) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num3
string (仕訳補助項目管理番号３) <= 10 characters
jnl_spcrs_mng_type4
string (仕訳補助項目管理種別４) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num4
string (仕訳補助項目管理番号４) <= 10 characters
jnl_spcrs_mng_type5
string (仕訳補助項目管理種別５) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num5
string (仕訳補助項目管理番号５) <= 10 characters
jnl_spcrs_mng_type6
string (仕訳補助項目管理種別６) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num6
string (仕訳補助項目管理番号６) <= 10 characters
jnl_spcrs_mng_type7
string (仕訳補助項目管理種別７) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num7
string (仕訳補助項目管理番号７) <= 10 characters
jnl_spcrs_mng_type8
string (仕訳補助項目管理種別８) <= 1 characters

0：学習機能を利用
1：未設定
2：マスタ設定

jnl_spcrs_mng_num8
string (仕訳補助項目管理番号８) <= 10 characters
jnl_spcrs_mng_type9
string (仕訳補助項目管理種別９) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt9
string (仕訳自由項目９) <= 200 characters

仕訳補助項目管理種別９の入力内容を指定する。

jnl_spcrs_mng_type10
string (仕訳補助項目管理種別１０) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt10
string (仕訳自由項目１０) <= 200 characters

仕訳補助項目管理種別１０の入力内容を指定する。

jnl_spcrs_mng_type11
string (仕訳補助項目管理種別１１) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt11
string (仕訳自由項目１１) <= 200 characters

仕訳補助項目管理種別１１の入力内容を指定する。

jnl_spcrs_mng_type12
string (仕訳補助項目管理種別１２) <= 1 characters

0：学習機能を利用
1：未設定
2：入力値

jnl_free_txt12
string (仕訳自由項目１２) <= 200 characters

仕訳補助項目管理種別１２の入力内容を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "customer_mng_num": "string",
  • "private_cust_cd": "string",
  • "user_mail": "string",
  • "user_name_sei": "string",
  • "user_name_mei": "string",
  • "user_name_sei_kana": "string",
  • "user_name_mei_kana": "string",
  • "corp_geniuine_id": "string",
  • "company_name_org": "string",
  • "company_name_kana_org": "string",
  • "base_name": "string",
  • "base_name_kana": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "phone": "string",
  • "fax": "string",
  • "private_user_id": "string",
  • "trfr_fee_bud_sec": "string",
  • "cust_private_bank": {
    },
  • "auto_refrect_flg": "string",
  • "auto_refrect_item": [
    ],
  • "coop_post_use_flg": "string",
  • "coop_post_type": "string",
  • "coop_post_use_invite_flg": "string",
  • "coop_post_use_invite_pay_flg": "string",
  • "destination_mng_num": "string",
  • "closing_days[]": {
    },
  • "send_flg": "string",
  • "send_date": "string",
  • "no_later_than_date": "string",
  • "debit_bur_sec_mng_type": "string",
  • "debit_bur_sec_mng_num": "string",
  • "debit_acc_mng_type": "string",
  • "debit_acc_mng_num": "string",
  • "debit_spcrs_mng_type": "string",
  • "debit_spcrs_mng_num": "string",
  • "credit_bur_sec_mng_type": "string",
  • "credit_bur_sec_mng_num": "string",
  • "credit_acc_mng_type": "string",
  • "credit_acc_mng_num": "string",
  • "credit_spcrs_mng_type": "string",
  • "credit_spcrs_mng_num": "string",
  • "biz_type": "string",
  • "biz_regist_no": "string",
  • "jnl_spcrs_mng_type1": "string",
  • "jnl_spcrs_mng_num1": "string",
  • "jnl_spcrs_mng_type2": "string",
  • "jnl_spcrs_mng_num2": "string",
  • "jnl_spcrs_mng_type3": "string",
  • "jnl_spcrs_mng_num3": "string",
  • "jnl_spcrs_mng_type4": "string",
  • "jnl_spcrs_mng_num4": "string",
  • "jnl_spcrs_mng_type5": "string",
  • "jnl_spcrs_mng_num5": "string",
  • "jnl_spcrs_mng_type6": "string",
  • "jnl_spcrs_mng_num6": "string",
  • "jnl_spcrs_mng_type7": "string",
  • "jnl_spcrs_mng_num7": "string",
  • "jnl_spcrs_mng_type8": "string",
  • "jnl_spcrs_mng_num8": "string",
  • "jnl_spcrs_mng_type9": "string",
  • "jnl_free_txt9": "string",
  • "jnl_spcrs_mng_type10": "string",
  • "jnl_free_txt10": "string",
  • "jnl_spcrs_mng_type11": "string",
  • "jnl_free_txt11": "string",
  • "jnl_spcrs_mng_type12": "string",
  • "jnl_free_txt12": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

支払先招待

  • 概要：支払先へ招待を行う。
  • 備考・補足： 初回招待のみ可能。再招待を行うことはできない。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

customer_mng_num
required
string (支払先管理番号) <= 13 characters

番号の先頭に以下の文字列を付与して指定。
未招待の場合：NI_
※招待済みのデータ(CM_xxxxxxxxxx)が指定された場合はエラー

invite_method
required
integer (招待方法) <= 10 characters

1：メールで招待
2：印刷で招待
4：FAXで招待
5：メール＋FAX

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "customer_mng_num": "string",
  • "invite_method": 0
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "customer_mng_num": "string"
}

請求仕訳

請求仕訳明細登録

  • 概要：BtoBの仕訳情報登録（明細形式）を登録する。
  • 備考・補足：
    すでに仕訳情報（明細形式）で登録されているデータがある場合は、全て再設定される。
    ※１ BtoB上に存在しない、項目を使用した場合、エラーとなる。
    ※２ オプション（仕訳自由項目有効（有料））に申し込まれていない場合、自由項目が設定されてい場合、該当の項目は登録されない。
    ※３ 申請されていない自由項目が設定されてい場合、該当の項目は登録されない。
    ※４ 連携される「仕訳情報」に該当項目が全て未設定の場合、BtoB上の該当項目の更新は実施しない。
    ※５ 連携される「仕訳情報」に該当の仕訳自由項目が全て未設定の場合、BtoB上の該当項目の更新は実施しない。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_id
required
string (請求書管理番号) <= 10 characters

BtoBの請求書を一意に識別するID

存在しない「請求書管理番号」を設定した場合はエラーとなる。

Array of objects (仕訳情報)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_id": "string",
  • "jnl_list[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

請求仕訳配賦登録

  • 概要：BtoBの仕訳情報登録（集計・配賦）を登録する。
  • 備考・補足：
    すでに仕訳情報（集計・配賦）で登録されているデータがある場合は、全て再設定される。
    ※１ BtoB上に存在しない、項目を使用した場合、エラーとなる。
    ※２ オプション（仕訳自由項目有効（有料））に申し込まれていない場合、自由項目が設定されてい場合、該当の項目は登録されない。
    ※３ 申請されていない自由項目が設定されてい場合、該当の項目は登録されない。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

invoice_id
required
string (請求書管理番号) <= 10 characters

BtoBの請求書を一意に識別するID

存在しない「請求書管理番号」を設定した場合はエラーとなる。

Array of objects (仕訳情報)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "invoice_id": "string",
  • "jnl_list[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

承認グループ

承認グループ取得

  • 概要：登録済みの承認グループ情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

approval_internal_flg
string (グループ種別：社内承認) <= 1 characters

0または未指定：含めない
1：含める

approval_accounting_flg
string (グループ種別：経理承認) <= 1 characters

0または未指定：含めない
1：含める

approval_final_accounting_flg
string (グループ種別：最終経理承認) <= 1 characters

0または未指定：含めない
1：含める

keyword
string (キーワード) <= 200 characters

検索対象：承認グループコード、承認グループ名称を部分一致で取得

accgroup_code
string (承認グループコード（検索用）) <= 15 characters

完全一致で取得

accgroup_name
string (承認グループ名称（検索用）) <= 100 characters

完全一致で取得

view_active_flg
string (非表示を含めるか否か) <= 1 characters

0または未指定：含めない
1：含める

accgroup_mng_num
string (承認グループ管理番号) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：承認グループコード（昇順）
1：承認グループコード（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "approval_internal_flg": "string",
  • "approval_accounting_flg": "string",
  • "approval_final_accounting_flg": "string",
  • "keyword": "string",
  • "accgroup_code": "string",
  • "accgroup_name": "string",
  • "view_active_flg": "string",
  • "accgroup_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "accgroups[]": [
    ]
}

承認グループ登録

  • 概要：承認グループの登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

accgroup_code
string (承認グループコード) <= 10 characters
accgroup_name
required
string (承認グループ名) <= 25 characters
approval_group_type
required
string (グループ種別) <= 1 characters

以下のいずれかを指定
1：社内承認用
2：経理承認用
3：最終経理承認用

Array of objects (社員情報リスト)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "accgroup_code": "string",
  • "accgroup_name": "string",
  • "approval_group_type": "string",
  • "employees[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "accgroup_mng_num": "string"
}

承認グループ更新

  • 概要：承認グループの更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

accgroup_mng_num
required
string (承認グループ管理番号) <= 10 characters
accgroup_code
string (承認グループコード) <= 10 characters
accgroup_name
required
string (承認グループ名) <= 25 characters
view_active_flg
string (非表示設定/非表示解除) <= 1 characters

0：非表示
1：表示

Array of objects (社員情報リスト)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "accgroup_mng_num": "string",
  • "accgroup_code": "string",
  • "accgroup_name": "string",
  • "view_active_flg": "string",
  • "employees[]": [
    ]
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "accgroup_mng_num": "string"
}

承認グループ削除

  • 概要：承認グループの削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

accgroup_mng_num
required
string (承認グループ管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "accgroup_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

宛先

宛先取得

  • 概要：登録済みの宛先情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 200 characters

検索対象：宛先コード、宛先、住所、承認グループを部分一致で取得

destination_code
string (宛先コード（検索用）) <= 10 characters

完全一致で取得

destination_name
string (宛先名（検索用）) <= 200 characters

完全一致で取得

address
string (住所（検索用）) <= 200 characters

完全一致で取得

accgroup_name
string (承認グループ（検索用）) <= 100 characters

完全一致で取得

destination_mng_num
string (宛先ID) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：宛先コード（昇順）
1：宛先コード（降順）
2：宛先名(昇順)
3：宛先名（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "destination_code": "string",
  • "destination_name": "string",
  • "address": "string",
  • "accgroup_name": "string",
  • "destination_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "destinations[]": [
    ]
}

宛先登録

  • 概要：請求書を受け取る宛先の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

destination_code
string (宛先コード) <= 15 characters
company_name
required
string (会社名) <= 60 characters

会社名と宛先名（事業所・営業所名）は合わせて全角29文字以内、半角58文字以内で指定する。

base_name
required
string (宛先名（事業所・営業所名）) <= 60 characters

会社名と宛先名（事業所・営業所名）は合わせて全角29文字以内、半角58文字以内で指定する。

company_name_kana
string (会社名(カナ)) <= 100 characters

会社名カナと宛先名（事業所・営業所名カナ）は合わせて全角カナ49文字以内、半角カナ98文字以内で指定する。

base_name_kana
string (宛先名（事業所・営業所名（カナ））) <= 100 characters

会社名カナと宛先名（事業所・営業所名カナ）は合わせて全角カナ49文字以内、半角カナ98文字以内で指定する。

phone
string (電話番号) <= 24 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX番号) <= 24 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1) <= 96 characters

市区町村を入力
住所1と住所2を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2) <= 96 characters

番地・建物名を入力
住所1と住所2を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

accgroup_code
string (承認グループコード) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "destination_code": "string",
  • "company_name": "string",
  • "base_name": "string",
  • "company_name_kana": "string",
  • "base_name_kana": "string",
  • "phone": "string",
  • "fax": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "accgroup_code": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "destination_mng_num": "string"
}

宛先更新

  • 概要：請求書を受け取る宛先の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

destination_mng_num
required
string (宛先管理番号) <= 10 characters
destination_code
string (宛先コード) <= 15 characters
company_name
required
string (会社名) <= 60 characters

会社名と宛先名（事業所・営業所名）は合わせて全角29文字以内、半角58文字以内で指定する。

company_name_kana
string (会社名カナ) <= 60 characters

会社名と宛先名（事業所・営業所名）は合わせて全角29文字以内、半角58文字以内で指定する。

base_name
required
string (宛先名（事業所・営業所名）) <= 100 characters

会社名カナと宛先名（事業所・営業所名カナ）は合わせて全角カナ49文字以内、半角カナ98文字以内で指定する。

base_name_kana
string (宛先名（事業所・営業所名（カナ））) <= 100 characters

会社名カナと宛先名（事業所・営業所名カナ）は合わせて全角カナ49文字以内、半角カナ98文字以内で指定する。

phone
string (電話番号) <= 24 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

fax
string (FAX番号) <= 24 characters

「XXXXX-XXXX-XXXX」の形式で指定する。
ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。

zip
string (郵便番号) <= 8 characters

「XXX-XXXX」の形式で指定する。

area_code
string (地域コード) <= 2 characters

00～47の地域コードを指定する。
地域コードと対応する都道府県はAppendixを参照。

address1
string (住所1（市町村）) <= 96 characters

市区町村を入力
住所1と住所2を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

address2
string (住所2（番地、建名物等）) <= 96 characters

番地・建物名を入力
住所1と住所2を合わせて、全角96文字以内で指定する。
「地域（都道府県）+住所1+住所2」で合わせて全角100文字以内で登録する。（各間の1文字含む）

accgroup_code
string (承認グループコード) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "destination_mng_num": "string",
  • "destination_code": "string",
  • "company_name": "string",
  • "company_name_kana": "string",
  • "base_name": "string",
  • "base_name_kana": "string",
  • "phone": "string",
  • "fax": "string",
  • "zip": "string",
  • "area_code": "string",
  • "address1": "string",
  • "address2": "string",
  • "accgroup_code": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "destination_mng_num": "string"
}

宛先削除

  • 概要：登録済みの宛先情報を削除する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

destination_mng_num
required
string (宛先管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "destination_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

勘定科目

勘定科目取得

  • 概要：登録済みの勘定科目を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 200 characters

検索対象：勘定科目コード、勘定科目名を部分一致で取得

acc_code
string (勘定科目コード（検索用）) <= 15 characters

完全一致で取得

acc_name
string (勘定科目名（検索用）) <= 30 characters

完全一致で取得

acc_mng_num
string (勘定科目管理番号) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：科目コード（昇順）
1：科目コード（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "acc_code": "string",
  • "acc_name": "string",
  • "acc_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "accs[]": [
    ]
}

勘定科目登録

  • 概要：勘定科目の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_code
required
string (勘定科目コード) <= 15 characters
acc_name
required
string (勘定科目名称) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_code": "string",
  • "acc_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "acc_mng_num": "string"
}

勘定科目更新

  • 概要：勘定科目の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_mng_num
required
string (勘定科目管理番号) <= 10 characters
acc_code
required
string (勘定科目コード) <= 15 characters
acc_name
required
string (勘定科目名称) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_mng_num": "string",
  • "acc_code": "string",
  • "acc_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "acc_mng_num": "string"
}

勘定科目削除

  • 概要：勘定科目の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_mng_num
required
string (勘定科目管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

勘定補助科目

勘定補助科目取得

  • 概要：登録済みの勘定補助科目情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_mng_num
string (勘定科目管理番号) <= 10 characters
keyword
string (キーワード) <= 200 characters

検索対象：補助科目コード、補助科目名称を部分一致で取得

acc_spcrs_code
string (補助科目コード（検索用）) <= 15 characters

完全一致で取得

acc_spcrs_name
string (補助科目名称（検索用）) <= 60 characters

完全一致で取得

acc_spcrs_mng_num
string (勘定補助科目管理番号) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：補助科目コード（昇順）
1：補助科目コード（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_mng_num": "string",
  • "keyword": "string",
  • "acc_spcrs_code": "string",
  • "acc_spcrs_name": "string",
  • "acc_spcrs_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "acc_spcrs[]": [
    ]
}

勘定補助科目登録

  • 概要：勘定補助科目の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_mng_num
required
string (勘定科目管理番号) <= 10 characters
acc_spcrs_code
required
string (勘定補助科目コード) <= 15 characters
acc_spcrs_name
required
string (勘定補助科目名) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_mng_num": "string",
  • "acc_spcrs_code": "string",
  • "acc_spcrs_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "acc_spcrs_mng_num": "string"
}

勘定補助科目更新

  • 概要：勘定補助科目の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_spcrs_mng_num
required
string (勘定補助科目管理番号) <= 10 characters
acc_spcrs_code
required
string (勘定補助科目コード) <= 15 characters
acc_spcrs_name
required
string (勘定補助科目名) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_spcrs_mng_num": "string",
  • "acc_spcrs_code": "string",
  • "acc_spcrs_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "acc_spcrs_mng_num": "string"
}

勘定補助科目削除

  • 概要：勘定補助科目の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

acc_spcrs_mng_num
required
string (勘定補助科目管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "acc_spcrs_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

負担部門

負担部門取得

  • 概要：登録済みの負担部門情報を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 200 characters

検索対象：負担部門コード、負担部門名称を部分一致で取得

burden_sec_code
string (負担部門コード（検索用）) <= 15 characters

完全一致で取得

burden_sec_name
string (負担部門名称（検索用）) <= 60 characters

完全一致で取得

burden_sec_mng_num
string (負担部門管理番号) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：負担部門コード（昇順）
1：負担部門コード（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "burden_sec_code": "string",
  • "burden_sec_name": "string",
  • "burden_sec_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "burden_sectors[]": [
    ]
}

負担部門登録

  • 概要：負担部門情報の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

burden_sec_code
required
string (負担部門コード) <= 15 characters
burden_sec_name
required
string (負担部門名) <= 500 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "burden_sec_code": "string",
  • "burden_sec_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "burden_sec_mng_num": "string"
}

負担部門更新

  • 概要：負担部門情報の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

burden_sec_mng_num
required
string (負担部門管理番号) <= 10 characters
burden_sec_code
required
string (負担部門コード) <= 15 characters
burden_sec_name
required
string (負担部門名) <= 500 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "burden_sec_mng_num": "string",
  • "burden_sec_code": "string",
  • "burden_sec_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "burden_sec_mng_num": "string"
}

負担部門削除

  • 概要：負担部門情報の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

burden_sec_mng_num
required
string (負担部門管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "burden_sec_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

仕訳補助項目

仕訳補助項目取得

  • 概要：登録済みの仕訳補助項目を取得する。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

jnl_free_disp_num
string (仕訳自由項目表示番号) <= 1 characters
keyword
string (キーワード) <= 200 characters

検索対象：仕訳補助項目コード、仕訳補助項目名称を完全一致で取得

jnl_spcrs_code
string (仕訳補助項目コード（検索用）) <= 15 characters

部分一致で取得

jnl_spcrs_name
string (仕訳補助項目名称（検索用）) <= 60 characters

部分一致で取得

jnl_spcrs_mng_num
string (仕訳補助項目管理番号) <= 10 characters
start_position
string (返却結果の先頭位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

sort
string (並び順) <= 1 characters

0または未指定：仕訳補助項目コード（昇順）
1：仕訳補助項目コード（降順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "jnl_free_disp_num": "string",
  • "keyword": "string",
  • "jnl_spcrs_code": "string",
  • "jnl_spcrs_name": "string",
  • "jnl_spcrs_mng_num": "string",
  • "start_position": "string",
  • "sort": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "total_count": "string",
  • "jnl_spcrs[]": [
    ]
}

仕訳補助項目登録

  • 概要：仕訳補助項目の登録を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

jnl_free_disp_code
required
string (仕訳自由項目コード) <= 15 characters
jnl_spcrs_code
required
string (仕訳補助項目コード) <= 15 characters
jnl_spcrs_name
required
string (仕訳補助項目名) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "jnl_free_disp_code": "string",
  • "jnl_spcrs_code": "string",
  • "jnl_spcrs_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "jnl_spcrs_mng_num": "string"
}

仕訳補助項目更新

  • 概要：仕訳補助項目の更新を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

jnl_spcrs_mng_num
required
string (仕訳補助項目管理番号) <= 10 characters
jnl_spcrs_code
required
string (仕訳補助項目コード) <= 15 characters
jnl_spcrs_name
required
string (仕訳補助項目名) <= 30 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "jnl_spcrs_mng_num": "string",
  • "jnl_spcrs_code": "string",
  • "jnl_spcrs_name": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "jnl_spcrs_mng_num": "string"
}

仕訳補助項目削除

  • 概要：仕訳補助項目の削除を行う。
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

jnl_spcrs_mng_num
required
string (仕訳補助項目管理番号) <= 10 characters

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "jnl_spcrs_mng_num": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ]
}

発行通知書

発行通知書取得

  • 概要：発行した通知書データを取得する。
    レスポンス情報および配列は以下の場合で異なる。
  1. 課税単位が「請求総額」又は「明細単位」の場合
  2. 保存方式が「フリーフォーマット」かつ、課税単位が「伝票単位」の場合
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

payment_send_date_from
required
string <date> (通知日（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

payment_send_date_to
required
string <date> (通知日（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_from
string <date> (入金期限（From）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date_to
string <date> (入金期限（To）) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

closing_date
string <date> (締日) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

confirmation_status
string (送付先確認状況フラグ) <= 1 characters

空白または0:全て
1:未開封
2:開封
3:確認済
4:返送済

customer_mng_num[]
Array of objects (支払先管理番号)

例）CM_999999999999

biz_type
string (支払先事業者区分) <= 1 characters

空白:全て
1:課税事業者
2:免税事業者

invoice_type
string (保存方式) <= 1 characters

空白:全て
0:請求書等保存方式
1:区分記載請求書等保存方式
2:フリーフォーマット
3:適格請求書等保存方式
4:適格請求書等保存方式（明細ごとに消費税を入力）

attached_file_flg
string (添付ファイル有) <= 1 characters

空白または0:全て
1:添付ファイル有

remand_flg
string (差戻し) <= 1 characters

空白または0:全て
1:差戻し

remind_flg
string (要催促) <= 1 characters

空白または0:全て
1:要催促

coop_post_use_setting_type
string (郵送代行利用状況) <= 1 characters

空白または0:全て
1:未利用
2:利用中

coop_post_delivery_date_from
string <date> (郵送代行発送日（From）) <= 10 characters

郵送代行利用状況で、2:利用中指定時の場合、必須。
「yyyy-MM-dd (JST)」の形式で指定する。
※2:利用中以外で指定された場合は無視する。

coop_post_delivery_date_to
string <date> (郵送代行発送日（To）) <= 10 characters

郵送代行利用状況で、2:利用中指定時の場合、必須。
「yyyy-MM-dd (JST)」の形式で指定する。
※2:利用中以外で指定された場合は無視する。

payment_amount_from
string (支払通知金額（from）) <= 13 characters

マイナス記号の指定も可能

payment_amount_to
string (支払通知金額（to）) <= 13 characters

マイナス記号の指定も可能

keyword
string (キーワード) <= 200 characters

検索対象：支払先、住所、TEL、件名、支払通知書番号、作成者、支払先担当者を部分一致で取得

destination_name
string (支払先名) <= 30 characters

完全一致

destination_code
string (支払先コード) <= 15 characters

完全一致

destination_address
string (住所) <= 100 characters

住所1または住所2に完全一致

destination_phone
string (TEL) <= 24 characters

完全一致

payment_name
string (件名) <= 40 characters

完全一致

payment_no
string (支払通知書番号) <= 20 characters

完全一致

create_user_name
string (作成者) <= 30 characters

完全一致

destination_user_name
string (支払先担当者) <= 30 characters

完全一致

payment_mng_num
string (支払通知書管理番号) <= 10 characters

完全一致

sort
string (並び順) <= 1 characters

空白または0:通知日(降順)
1:通知日(昇順)
2:支払先コード(降順)
3:支払先コード(昇順)
4:支払通知金額(降順)
5:支払通知金額(昇順)

start_position
string (取得開始位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、取得件数で指定した件数を返却する。（指定が無い場合は指定位置から100件を返却）

get_count
string (取得件数) <= 3 characters

指定がない場合は100件を返却。
1~99の範囲で数値を指定し、指定された件数のデータを返却。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "payment_send_date_from": "yyyy-MM-dd",
  • "payment_send_date_to": "yyyy-MM-dd",
  • "pay_due_date_from": "yyyy-MM-dd",
  • "pay_due_date_to": "yyyy-MM-dd",
  • "closing_date": "yyyy-MM-dd",
  • "confirmation_status": "string",
  • "customer_mng_num[]": [
    ],
  • "biz_type": "string",
  • "invoice_type": "string",
  • "attached_file_flg": "string",
  • "remand_flg": "string",
  • "remind_flg": "string",
  • "coop_post_use_setting_type": "string",
  • "coop_post_delivery_date_from": "yyyy-MM-dd",
  • "coop_post_delivery_date_to": "yyyy-MM-dd",
  • "payment_amount_from": "string",
  • "payment_amount_to": "string",
  • "keyword": "string",
  • "destination_name": "string",
  • "destination_code": "string",
  • "destination_address": "string",
  • "destination_phone": "string",
  • "payment_name": "string",
  • "payment_no": "string",
  • "create_user_name": "string",
  • "destination_user_name": "string",
  • "payment_mng_num": "string",
  • "sort": "string",
  • "start_position": "string",
  • "get_count": "string"
}

Response samples

Content type
Example
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "payment[]": [
    ]
}

通知書登録

  • 概要：通知書の登録および発行を行う。
    リクエスト配列は以下の場合で異なる。
  1. 課税単位が「請求総額」又は「明細単位」の場合
  2. 保存方式が「フリーフォーマット」かつ、課税単位が「伝票単位」の場合
  • 備考・補足： 通知書書式設定はAPIからは設定できません。画面より設定を行ってください。
Request Body schema:
One of
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

payment_title
string (支払通知書タイトル) <= 12 characters
payment_no
string (支払通知番号) <= 20 characters
payment_amount_title
string (支払通知金額タイトル) <= 10 characters
contact
string (担当者) <= 30 characters

問い合わせ先を直接入力する。

closing_date
string <date> (締日) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

pay_due_date
string <date> (入金期限) <= 10 characters

「yyyy-MM-dd (JST)」の形式で指定する。

payment_name
string (件名) <= 40 characters
payment_amount
required
string (おもての通知金額) <= 13 characters

マイナス記号を含めない桁数

customer_mng_num
required
string (支払先管理番号) <= 13 characters

例）CM_999999999999

biz_type
string (事業者区分) <= 1 characters

空白:未指定（支払先マスタの表示値を参照）
1:課税事業者
2:免税事業者

biz_regist_no
string (事業者登録番号) <= 14 characters

例）T9999999999999
事業者区分が"1"の場合のみ有効

publisher_mng_num
string (送付元管理番号) <= 10 characters
payment_setting_mng_num
string (通知書書式設定管理番号) <= 10 characters
pay_without_tax_tr10
string (10%請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_tr10
string (10%消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_tr10
string (10%請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_tr8_reduced
string (軽減8%請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_tr8_reduced
string (軽減8%消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_tr8_reduced
string (軽減8%請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_tr8
string (8%請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_tr8
string (8%消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_tr8
string (8%請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_tr5
string (5%請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_tr5
string (5%消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_tr5
string (5%請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_tr0
string (0%請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_tr0
string (0%消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_tr0
string (0%請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_free
string (非課税請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_free
string (非課税消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_free
string (非課税請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_exemption
string (免税請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_exemption
string (免税消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_exemption
string (免税請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_without_tax_non
string (不課税請求金額（税抜）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_tax_non
string (不課税消費税額) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_amount_non
string (不課税請求金額（税込）) <= 13 characters

マイナス記号を含めない桁数
指定可否、条件付き必須条件は、Appendix:「税率ごとの合計金額」の入力必須条件参照。

pay_free_txt01
string (おもての自由項目_A項目1（文字）) <= 8 characters
pay_free_txt02
string (おもての自由項目_A項目2（文字）) <= 8 characters
pay_free_txt03
string (おもての自由項目_A項目3（文字）) <= 8 characters
pay_free_num01
string (おもての自由項目_B項目1（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num02
string (おもての自由項目_B項目2（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num03
string (おもての自由項目_B項目3（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num04
string (おもての自由項目_B項目4（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num05
string (おもての自由項目_B項目5（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num06
string (おもての自由項目_B項目6（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num07
string (おもての自由項目_B項目7（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num08
string (おもての自由項目_B項目8（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num09
string (おもての自由項目_B項目9（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num10
string (おもての自由項目_B項目10（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num11
string (おもての自由項目_B項目11（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num12
string (おもての自由項目_B項目12（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num13
string (おもての自由項目_B項目13（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

pay_free_num14
string (おもての自由項目_B項目14（数値）) <= 18 characters

整数部13小数部3　マイナス記号、小数点は含めない桁数

remarks
string (備考) <= 500 characters
payment_bank
string (支払通知書振込先口座情報) <= 75 characters
Array of objects (明細情報)
object (カスタム情報)

Responses

Request samples

Content type
Example
{
  • "response_type": "string",
  • "payment_title": "string",
  • "payment_no": "string",
  • "payment_amount_title": "string",
  • "contact": "string",
  • "closing_date": "yyyy-MM-dd",
  • "pay_due_date": "yyyy-MM-dd",
  • "payment_name": "string",
  • "payment_amount": "string",
  • "customer_mng_num": "string",
  • "biz_type": "string",
  • "biz_regist_no": "string",
  • "publisher_mng_num": "string",
  • "payment_setting_mng_num": "string",
  • "pay_without_tax_tr10": "string",
  • "pay_tax_tr10": "string",
  • "pay_amount_tr10": "string",
  • "pay_without_tax_tr8_reduced": "string",
  • "pay_tax_tr8_reduced": "string",
  • "pay_amount_tr8_reduced": "string",
  • "pay_without_tax_tr8": "string",
  • "pay_tax_tr8": "string",
  • "pay_amount_tr8": "string",
  • "pay_without_tax_tr5": "string",
  • "pay_tax_tr5": "string",
  • "pay_amount_tr5": "string",
  • "pay_without_tax_tr0": "string",
  • "pay_tax_tr0": "string",
  • "pay_amount_tr0": "string",
  • "pay_without_tax_free": "string",
  • "pay_tax_free": "string",
  • "pay_amount_free": "string",
  • "pay_without_tax_exemption": "string",
  • "pay_tax_exemption": "string",
  • "pay_amount_exemption": "string",
  • "pay_without_tax_non": "string",
  • "pay_tax_non": "string",
  • "pay_amount_non": "string",
  • "pay_free_txt01": "string",
  • "pay_free_txt02": "string",
  • "pay_free_txt03": "string",
  • "pay_free_num01": "string",
  • "pay_free_num02": "string",
  • "pay_free_num03": "string",
  • "pay_free_num04": "string",
  • "pay_free_num05": "string",
  • "pay_free_num06": "string",
  • "pay_free_num07": "string",
  • "pay_free_num08": "string",
  • "pay_free_num09": "string",
  • "pay_free_num10": "string",
  • "pay_free_num11": "string",
  • "pay_free_num12": "string",
  • "pay_free_num13": "string",
  • "pay_free_num14": "string",
  • "remarks": "string",
  • "payment_bank": "string",
  • "details[]": [
    ],
  • "custom": {
    }
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "payment_mng_num": "string"
}

通知書書式

通知書書式一覧取得

  • 概要：通知書書式情報の一覧データを取得するAPI
Request Body schema:
response_type
required
string (レスポンス形式) <= 4 characters

"xml"か"json"で指定されていること。

keyword
string (キーワード) <= 200 characters

検索対象：通知書書式設定コード（検索用）、通知書書式設定名称（検索用）を部分一致で取得

payment_setting_code
string (通知書書式設定コード（検索用）) <= 15 characters

完全一致で取得

payment_setting_name
string (通知書書式設定名称（検索用）) <= 60 characters

完全一致で取得

view_active
string (非表示を含めるか) <= 1 characters

0：非表示を含める
空白または1：非表示を含めない

start_position
string (取得開始位置) <= 10 characters

何件目の検索結果からデータを返却するかを指定する。
指定が無い場合、1が指定。指定時は、先頭位置を含めて100件を上限として返却する。
(例：1を指定→1～100件目、5を指定→5～104件目)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "keyword": "string",
  • "payment_setting_code": "string",
  • "payment_setting_name": "string",
  • "view_active": "string",
  • "start_position": "string"
}

Response samples

Content type
{
  • "result": "string",
  • "error_list[]": [
    ],
  • "layout_list[]": [
    ],
  • "total_count": "string"
}

Appendix

補足資料

ReleaseNote

請求書

更新日 API 内容
2023/1/25 新規作成
2023/2/17 請求書処理済みAPI リクエストの「自社支払期限」のパラメータ名、必須条件、備考を更新
2023/2/27 請求書書式取得API 項目変更
・請求書の保存方式
・課税単位
項目追加
・税区分指定
・税率ごとに区分した対価の額の表示
・保存方式等の補足文言利用フラグ
・保存方式等の補足文言
2023/2/27 請求書書式登録API 項目変更
・請求書の保存方式
・課税単位
・金額相違請求書作成可能フラグ
・明細項目利用設定 - 明細日付
項目追加
・税区分指定
・税率ごとに区分した対価の額の表示
・保存方式等の補足文言利用フラグ
・保存方式等の補足文言
2023/2/27 請求書書式更新API 項目変更
・請求書の保存方式
・課税単位
・金額相違請求書作成可能フラグ
・明細項目利用設定 - 明細日付
項目追加
・税区分指定
・税率ごとに区分した対価の額の表示
・保存方式等の補足文言利用フラグ
・保存方式等の補足文言
2023/3/16 請求データ取得API 全体的に配列構成、並び順を見直し修正
2023/4/19 発行先取得API 項目修正（備考修正）
・招待郵送代行サービス利用区分
項目廃止
・発行先システムコード（発行先管理番号と重複のため）
2023/4/19 支払先取得API 項目廃止
・支払先システムコード（支払先管理番号と重複のため）
2023/4/19 発行先登録API
発行先更新API		 項目修正（桁数修正）
・住所1
・住所2
・TEL
・FAX
項目修正（備考修正）
・郵送代行サービス利用区分（請求書・通知書）
・郵送代行サービス利用区分（招待）
・郵送請求書/通知書タイプ
・郵送代行サービス広告同封フラグ
項目修正（名前修正）
・郵送代行サービス利用区分（招待）
項目廃止（設定できない項目のため）
・振込手数料負担種別
・郵送代行サービス利用区分(通知書招待)
・宛先種別
2023/4/19 支払先登録API
支払先更新API		 項目修正（桁数修正）
・住所1
・住所2
・TEL
・FAX
項目修正（備考修正）
・郵送代行サービス利用区分（請求書・通知書）
・郵送請求書/通知書タイプ
・郵送代行サービス利用区分(請求書招待)
・郵送代行サービス利用区分(通知書招待)
・郵送代行サービス広告同封フラグ
項目修正（名前修正）
・郵送代行サービス利用区分(請求書招待)
・入金期限(日)1
項目追加
・締日(配列)
・締日１
・締日２
・締日３
・締日４
・締日５
項目廃止（設定できない項目のため）
・本文
2023/4/19 請求書一覧取得API
請求データ取得API		 項目修正（桁数修正）
・請求金額（From）
・請求金額（To）
2023/4/19 請求書登録API
請求書登録API(伝票単位)
請求書更新API
請求書更新API(伝票単位)		 項目廃止（設定できない項目のため）
・税額入力形式区分
2023/4/26 支払先登録API
支払先更新API		 パラメータ名変更
・借方補助科目管理番号（debit_spcrs_mng_code→debit_spcrs_mng_num）
・貸方補助科目管理番号（credit_spcrs_mng_code→credit_spcrs_mng_num）
項目修正（要素内容修正）
・郵送請求書/通知書タイプ（郵送通知書タイプ→郵送請求書/通知書タイプ）
項目修正（備考修正）
・郵送請求書/通知書タイプ
2023/4/26 発行先登録API
発行先更新API		 項目修正（備考修正）
・郵送請求書/通知書タイプ
2023/4/26 支払先取得API 項目修正（要素内容修正）
・郵送請求書/通知書タイプ（郵送通知書タイプ→郵送請求書/通知書タイプ）
・郵送代行サービス広告同封フラグ（広告同封→郵送代行サービス広告同封フラグ）
2023/4/26 発行先取得API 項目修正（要素内容修正）
・郵送請求書/通知書タイプ（郵送通知書タイプ→郵送請求書/通知書タイプ）
・郵送代行サービス広告同封フラグ（広告同封→郵送代行サービス広告同封フラグ）
項目修正（備考修正）
・郵送請求書/通知書タイプ
2023/5/12 請求書書式一覧取得API 項目修正（備考修正）
・非表示を含めるか
2023/5/12 発行先取得API
 項目修正（項目名誤記修正）
・つ→請求書未確認
2023/5/12 発行先招待API 項目修正（項目名誤記修正）
・支払先管理番号→発行先管理番号
2023/5/12 支払先登録API
支払先更新API		 項目廃止
・郵送代行サービス広告同封フラグ（現在利用していないフラグのため）
2023/5/12 発行先登録API
発行先更新API		 項目廃止
・郵送代行サービス広告同封フラグ（現在利用していないフラグのため）
2023/5/12 請求書書式一覧取得API パラメータ名変更
・請求書書式設定管理番号（layout_seq→invoice_setting_mng_num）
2023/5/12 請求書PDF・添付ファイルAPI 追加（バージョン1を流用）
2023/6/21 請求書一覧取得API 項目修正（備考修正）
・抽出種別(差戻し)（発行済請求書のみ取得できるため、①②は抽出対象外）
2023/6/21 請求書登録API
請求書登録API(伝票単位)
請求書再登録API
請求書再登録API(伝票単位)		 項目追加（失敗時）
・請求書管理番号（値はnullで出力される）
2023/6/21 発行先取得API 項目追加（失敗時）
・発行先(値はnullで出力される）
・抽出結果件数(0を出力）
2023/6/21 発行先登録API
発行先更新API
発行先招待API		 項目追加（失敗時）
・発行先管理番号（値はnullで出力される）
2023/6/21 発行元取得API 項目追加（失敗時）
・発行元(値はnullで出力される）
・抽出結果件数(0を出力）
2023/6/21 発行元登録API
発行元更新API		 項目追加（失敗時）
・発行元管理番号（値はnullで出力される）
2023/6/21 振込先口座取得API パラメータ名変更
・振込先口座情報（banks[]→bank_list[]）
項目追加
・データ連番
項目追加（失敗時）
・振込先口座情報(値はnullで出力される）
・抽出結果件数(0を出力）
2023/6/21 振込先口座登録API
振込先口座更新API		 項目追加（失敗時）
・口座管理番号（値はnullで出力される）
2023/6/21 請求データ取得API 項目追加（失敗時）
・抽出結果件数(0を出力）
2023/6/21 請求書処理済みAPI
請求書差戻しAPI		 項目追加（失敗時）
・請求書管理番号（値はnullで出力される）
2023/6/21 支払先取得API 項目追加（失敗時）
・支払先(値はnullで出力される）
・抽出結果件数(0を出力）
2023/6/21 支払先登録API
支払先更新API
支払先招待API		 項目追加（失敗時）
・支払先管理番号（値はnullで出力される）
2023/6/21 支払先登録API
支払先更新API		 パラメータ名変更
・締日(配列)（closing_day[]→closing_days[]）
項目廃止（設定できない項目のため）
・宛先種別
2023/6/21 請求書書式登録API
請求書書式更新API		 項目修正（必須条件、備考修正）
・締日
・入金期限月
・入金期限日
・振込先管理番号
2023/6/21 発行先招待API 項目修正（必須条件）
・発行先管理番号
2023/6/21 支払先招待API 項目修正（必須条件）
・支払先管理番号
2023/12/13 発行先登録API 項目修正（備考修正）
・振込先口座1
・振込先口座2
・振込先口座3
・振込先口座4
・振込先口座5
2023/12/13 請求書書式一覧取得API パラメータ名変更
・キーワード（keywords→keyword）
2023/12/13 発行先登録API
発行先更新API
宛先登録API
宛先更新API		 項目修正（桁数修正）
・郵便番号
2023/12/13 請求書処理済みAPI
請求書差戻しAPI		 ５．備考・補足に追記
2023/12/13 発行先取得API
支払先取得API		 項目修正（備考修正）
・招待履歴
・招待先のログイン状況
・返却結果の先頭位置
2023/12/13 発行先登録API
発行先更新API		 項目修正（要素内容修正）
・郵送代行サービス利用区分（請求書）（郵送代行サービス利用区分（請求書・通知書）→郵送代行サービス利用区分（請求書））
2023/12/13 支払先登録API
支払先更新API		 項目修正（要素内容修正）
・郵送代行サービス利用区分（通知書）（郵送代行サービス利用区分（請求書・通知書）→郵送代行サービス利用区分（通知書））
2023/12/13 請求書書式画像取得API パラメータ名変更
・請求書書式設定管理番号（invoice_setting_meg_num→invoice_setting_mng_num）
2023/12/13 請求書一覧取得API 項目修正（備考修正）
・住所
2023/12/13 支払先取得API 項目追加
・通知書書式設定管理番号
・通知書書式設定コード
・通知書書式設定名称
2024/02/21 請求書一覧取得API
請求データ取得API		 項目追加
・代表者役職
・代表者名
2024/02/21 請求データ取得API 項目修正（備考修正）
REQUEST BODY SCHEMA
・事業者区分
RESPONSE SCHEMA
・事業者区分
2024/03/18 請求データ取得API 項目修正（備考修正）
REQUEST BODY SCHEMA
・受取日(To)
2024/03/18 支払先更新API HTTPメソッドの記載誤り
POST→PUT

通知書

更新日 API 内容
2023/2/16 新規作成
2023/2/27 発行通知書取得APIの項目並び替え
2023/3/3 発行通知書取得API (伝票単位)
通知書登録API (伝票単位)		 発行通知書取得API (伝票単位)のレスポンスにあるカスタム情報の階層を変更
通知書登録API (伝票単位)のリクエストにあるカスタム情報の階層を変更
2023/12/13 発行通知書取得API
発行通知書取得API (伝票単位)
通知書登録API
通知書登録API (伝票単位)
通知書書式一覧取得API		 リリースに伴いリクエストおよびレスポンスを最新化
2023/12/13 発行通知書取得API
発行通知書取得API (伝票単位)		 URL修正
正）https://api.infomart.co.jp/wi/v2/buyer/payment/search
誤）https://api.infomart.co.jp/wi/v2/seller/payment/search
2023/12/13 通知書書式一覧取得API URL修正
正）https://api.infomart.co.jp/wi/v2/buyer/profile/payment/layout/search
誤）https://api.infomart.co.jp/wi/v2/buyer/profile/layout/search
2023/12/13 発行通知書取得API
発行通知書取得API (伝票単位)		 ・「住所」の備考訂正
　「住所1または住所2に完全一致」
2023/12/13 通知書登録API (伝票単位) ・誤記訂正
「伝票番号」から「半角英数」の記載を削除