このAPIは非推奨APIとなっており順次廃止予定となっております。廃止予定の非推奨APIにあわせて、代替APIを下記の通りご用意させていただいております。
請求先部署登録
/api/billing_individual/add
請求先部署情報処理を実行します。
アウトライン
リクエスト
- Path:
/api/billing_individual/add - Preferred HTTP method:
POST - Accepted content types:
application/x-www-form-urulencoded - Encode:
UTF-8
Parameters
| 名前 | 概要 | 桁数 | 種別 | 必須 |
|---|---|---|---|---|
| user_id | ユーザーID（管理画面へのログインID） | 100 | メール形式 | 必須 |
| access_key | アクセスキー | 100 | 半角英数 + 記号 | 必須 |
| billing_code | 請求先コード 両端のスペース除去 |
20 | 半角英数 + 記号 | 必須 |
| billing_individual_code | 請求先部署コード | 20 | 半角英数 + 記号 | |
| billing_individual_name | 請求先部署名 両端のスペース除去 |
100 | 文字列 | 必須 |
| link_customer_code | 会計ソフト連携用取引先コード | 20 | 半角英数 | |
| address1 | 宛名1 両端のスペース除去 |
60 | 文字列 | 必須 |
| address2 | 宛名2 ※両端のスペース除去 |
60 | 文字列 | |
| address3 | 宛名3 ※両端のスペース除去 |
60 | 文字列 | |
| zip_code | 郵便番号 両端のスペース除去 |
7 | 数値 | 必須 |
| pref | 都道府県 | 4 | 文字列 | 必須 |
| city_address | 市区町村番地 両端のスペース除去 |
56 | 文字列 | 必須 |
| building_name | 建物名 ※両端のスペース除去 |
60 | 文字列 | |
| set_post_address | 郵送宛先情報 0:使用しない 1:使用する ※両端のスペース除去 |
1 | 数値 | |
| post_address1 | 郵送先宛名1 両端のスペース除去 |
60 | 文字列 | (set_post_address=1時) |
| post_address2 | 郵送先宛名2 ※両端のスペース除去 |
60 | 文字列 | |
| post_address3 | 郵送先宛名3 ※両端のスペース除去 |
60 | 文字列 | |
| post_zip_code | 郵送先郵便番号 両端のスペース除去 |
7 | 数値 | (set_post_address=1時) |
| post_pref | 郵送先都道府県 | 4 | 文字列 | (set_post_address=1時) |
| post_city_address | 郵送先市区町村番地 ※両端のスペース除去 |
56 | 文字列 | (set_post_address=1時) |
| post_building_name | 郵送先建物名 ※両端のスペース除去 |
60 | 文字列 | |
| tel | 電話番号 両端のスペース除去 |
15 | 数値、半角ハイフン | (payment_method=1,2,6,7時) |
| メールアドレス 両端のスペース除去 |
100 | メール形式 | 必須 | |
| cc_email | CC送信先メールアドレス ※両端のスペース除去 |
256 | メール形式 | |
| bs_owner_code | 請求元担当者コード ※両端のスペース除去 |
20 | 半角英数 + 記号 | |
| payment_method | 決済手段 0:銀行振込 1:クレジットカード 2:バンクチェック 3:RP口座振替 4:RL口座振替 5:その他口座振替 6:コンビニ払込票(A4) 7:コンビニ払込票(ハガキ) |
1 | 数値 | 必須 |
| source_bank_account_name | 振込元口座名義 ※payment_method=0,2の場合に必要(入力は任意) |
48 | 口座名義 | |
| credit_number | クレジットカード番号(ハイフンはつけない) 両端のスペース除去 |
20 | 数値 | (payment_method=1時) |
| credit_expiration_date | クレジットカード有効期限(YYMM形式) 両端のスペース除去 |
4 | 数値 | (payment_method=1時) |
| credit_first_name | クレジットカード名義(名) 両端のスペース除去 |
20 | アルファベット | (payment_method=1時) |
| credit_last_name | クレジットカード名義(姓) 両端のスペース除去 |
20 | アルファベット | (payment_method=1時) |
| customer_number | 顧客番号 ※payment_method=5の場合に必要(入力は任意) |
20 | 半角英数 | |
| bank_code | 銀行コード ※payment_method=3,4,5の場合に必要(入力は任意) |
4 | 数値 | |
| bank_name | 銀行名 ※payment_method=5の場合に必要(入力は任意) ※ゆうちょの場合は「ﾕｳﾁﾖ」 |
15 | 銀行名等 | |
| branch_code | 支店コード ※payment_method=3,4,5の場合に必要(入力は任意) |
3 | 数値 | |
| branch_name | 支店名 ※payment_method=5の場合に必要(入力は任意) |
15 | 銀行名等 | |
| bank_account_type | 預金種目 1:普通 2:当座 |
1 | 数値 | (payment_method=3,4,5時) |
| bank_account_number | 口座番号 ※payment_method=3,4,5の場合に必要(入力は任意) ※payment_method=3でゆうちょの時の桁数は8桁固定 |
7 | 数値 | |
| bank_account_name | 口座名義 ※payment_method=3,4,5の場合に必要(入力は任意) ※payment_method=3時の桁数は30桁 |
100 | 口座名義 | |
| ref_billing_code | 合計請求書用請求先コード | 20 | 半角英数 + 記号 | (ref_individual_number or ref_individual_code指定時) |
| ref_individual_number | 合計請求書用請求先部署番号 | 20 | 数値 | (合計請求書時)^1 |
| ref_individual_code | 合計請求書用請求先部署コード | 20 | 半角英数 + 記号 | (合計請求書時)^1 |
| bill_template_code | 請求書テンプレートコード ※合計請求書をご利用される場合は、お手数ですがお問い合わせください |
数値 | ||
| payment_method_code | 決済情報コード | 20 | 半角英数 + 記号 | |
| payment_method_name | 決済情報名 | 100 | 文字列 | |
| account_receivable_code | 請求先部署売掛金補助科目コード ※追加省略時、nullで登録される |
25 | 文字列 | |
| advances_received_code | 請求先部署前受金補助科目コード ※追加省略時、nullで登録される |
25 | 文字列 | |
| suspense_received_code | 請求先部署仮受金補助科目コード ※追加省略時、nullで登録される |
25 | 文字列 |
レスポンス
- Type:
application/json - Encode:
UTF-8
Fields
| 名前 | 概要 | 型 |
|---|---|---|
| billing_individual | 請求先部署に属するパラメータ | array |
billing_individual (response)
下記のような項目のオブジェクトを持つリスト
| 名前 | 概要 | 型 |
|---|---|---|
| number | 請求先部署番号 | int |
| code | 請求先部署コード | string |
| name | 請求先部署名 | string |
| link_customer_code | 会計ソフト連携用取引先コード | string |
| address1 | 宛名1 | string |
| address2 | 宛名2 | string |
| address3 | 宛名3 | string |
| zip_code | 郵便番号 | string |
| pref | 都道府県 | string |
| city_address | 市区町村番地 | string |
| building_name | 建物名 | string |
| set_post_address | 郵送宛先情報 0:使用しない 1:使用する |
int |
| post_address1 | 郵送先宛名1 | string |
| post_address2 | 郵送先宛名2 | string |
| post_address3 | 郵送先宛名3 | string |
| post_zip_code | 郵送先郵便番号 | string |
| post_pref | 郵送先都道府県 | string |
| post_city_address | 郵送先市区町村番地 | string |
| post_building_name | 郵送先建物名 | string |
| tel | 電話番号 | string |
| メールアドレス | string | |
| cc_email | CC送信先メールアドレス | string |
| bs_owner_code | 請求元担当者コード | string |
| payment_method | 決済手段 0:銀行振込 1:クレジットカード 2:バンクチェック 3:RP口座振替 4:RL口座振替 5:その他口座振替 6:コンビニ払込票(A4) 7:コンビニ払込票(ハガキ) |
int |
| register_status | 登録ステータス 0:未登録 1:登録待ち 2:メール送信済み 3:申請中 4:登録情報_送信エラー 5:登録完了 6:登録失敗 |
int |
| source_bank_account_name | 振込元口座名義 ※payment_method=0,2以外はNULL |
string |
| customer_number | 顧客番号 ※payment_method=5以外はNULL |
string |
| bank_code | 銀行コード ※payment_method=3,4,5以外はNULL |
string |
| bank_name | 銀行名 ※payment_method=5以外はNULL |
string |
| branch_code | 支店コード ※payment_method=3,4,5以外はNULL |
string |
| branch_name | 支店名 ※payment_method=5以外はNULL |
string |
| bank_account_type | 預金種目 1:普通 2:当座 ※payment_method=3,4,5以外はNULL |
string |
| bank_account_number | 口座番号 ※payment_method=3,4,5以外はNULL |
string |
| bank_account_name | 口座名義 ※payment_method=3,4,5以外はNULL |
string |
| gid | 決済番号 ※payment_method=1以外はNULL |
string |
| bank_check_bank_code | バンクチェック銀行コード ※payment_method=2以外はNULL |
string |
| bank_check_bank_name | バンクチェック銀行名 ※payment_method=2以外はNULL |
string |
| bank_check_branch_code | バンクチェック支店コード ※payment_method=2以外はNULL |
string |
| bank_check_branch_name | バンクチェック支店名 ※payment_method=2以外はNULL |
string |
| bank_check_kind | バンクチェック口座種別 ※NULL string |
string |
| bank_check_bank_account_number | バンクチェック口座番号 ※payment_method=2以外はNULL |
string |
| ref_billing_code | 合計請求書用請求先コード | string |
| ref_individual_number | 合計請求書用請求先部署番号 | string |
| ref_individual_code | 合計請求書用請求先部署コード | string |
| bill_template_code | 請求書テンプレートコード | string |
| payment_method_number | 決済情報番号 | int |
| payment_method_code | 決済情報コード | string |
| payment_method_name | 決済情報名 | string |
| account_receivable_code | 請求先部署売掛金補助科目コード | string |
| advances_received_code | 請求先部署前受金補助科目コード | string |
| suspense_received_code | 請求先部署仮受金補助科目コード | string |
使用例
リクエスト例
user_id: "sample@robotpayment.co.jp"
access_key: "xxxxxxxxxxxxxxxx"
billing_code: "billing"
billing_individual_code: "bicd0001"
billing_individual_name: "請求先部署名"
link_customer_code: "1234"
address1: "宛名1"
address2: "宛名2"
address3: "宛名3"
zip_code: "1651111"
pref: "東京都"
city_address: "渋谷区"
building_name: "建物名"
set_post_address: "1"
post_address1: "郵送先宛名1"
post_address2: "郵送先宛名2"
post_address3: "郵送先宛名3"
post_zip_code: "1651110"
post_pref: "東京都"
post_city_address: "港区"
post_building_name: "建物名"
tel: "0811112222"
email: email@robotpayment.co.jp
cc_email:sub1email@robotpayment.co.jp,sub2email@robotpayment.co.jp
bs_owner_code:"bs_owner_code"
payment_method: 0
source_bank_account_name: "ｹｲﾘﾉﾐｶﾀ"
credit_number: null
credit_expiration_date: null
credit_first_name: null
credit_last_name: null
customer_number: null
bank_code: null
bank_name: null
branch_code: null
branch_name: null
bank_account_type: null
bank_account_number: null
bank_account_name: null
ref_billing_code: null
ref_individual_number: null
ref_individual_code: null
bill_template_code: null
payment_method_number: 123
payment_method_code: "bank-123"
payment_method_name: "銀行振込123"
account_receivable_code: null
advances_received_code: null
suspense_received_code: null
レスポンス例
Status: 200 OK
{
"billing_individual": {
"number": 1,
"code": "bicd0001",
"name": "請求先部署名",
"link_customer_code": "1234",
"address1": "宛名1",
"address2": "宛名2",
"address3": "宛名3",
"zip_code": "1651111",
"pref": "東京都",
"city_address": "渋谷区",
"building_name": "建物名",
"set_post_address": 1,
"post_address1": "郵送先宛名1",
"post_address2": "郵送先宛名2",
"post_address3": "郵送先宛名3",
"post_zip_code": "1651110",
"post_pref": "東京都",
"post_city_address": "港区",
"post_building_name": "建物名",
"tel": "0811112222",
"email": "email@robotpayment.co.jp",
"cc_email": " sub1email@robotpayment.co.jp,sub2email@robotpayment.co.jp",
"bs_owner_code": "bs_owner_code",
"payment_method": 0,
"register_status": 5,
"source_bank_account_name": "ｹｲﾘﾉﾐｶﾀ",
"customer_number": null,
"bank_code": null,
"bank_name": null,
"branch_code": null,
"branch_name": null,
"bank_account_type": null,
"bank_account_number": null,
"bank_account_name": null,
"gid": null,
"bank_check_bank_code": null,
"bank_check_bank_name": null,
"bank_check_branch_code": null,
"bank_check_branch_name": null,
"bank_check_kind": null,
"bank_check_bank_account_number": null,
"ref_billing_code": null,
"ref_individual_number": null,
"ref_individual_code": null,
"bill_template_code": null,
"payment_method_number": 123,
"payment_method_code": "bank-123",
"payment_method_name": " 銀行振込123",
"account_receivable_code": null,
"advances_received_code": null,
"suspense_received_code": null
}
}
エラー
個別エラー
| エラーコード | 内容 |
|---|---|
| 1001 | 請求先コードが不正 |
| 1002 | 請求先部署名が不正 |
| 1003 | 会計ソフト連携用取引先コードが不正 |
| 1004 | 宛名1が不正 |
| 1005 | 宛名2が不正 |
| 1006 | 宛名3が不正 |
| 1007 | 郵便番号が不正 |
| 1008 | 都道府県が不正 |
| 1009 | 市区町村番地が不正 |
| 1010 | 建物名が不正 |
| 1011 | 電話番号が不正 |
| 1012 | メールアドレスが不正 |
| 1013 | 決済手段が不正 |
| 1014 | 振込元口座名義が不正 |
| 1015 | クレジットカード番号が不正 |
| 1016 | クレジットカード有効期限が不正 |
| 1017 | クレジットカード名義(名)が不正 |
| 1018 | クレジットカード名義(姓)が不正 |
| 1019 | 銀行コードが不正 |
| 1020 | 支店コードが不正 |
| 1021 | 預金種目が不正 |
| 1022 | 口座番号が不正 |
| 1023 | 口座名義が不正 |
| 1024 | 顧客番号が不正 |
| 1025 | 銀行名が不正 |
| 1026 | 支店名が不正 |
| 1027 | 請求元担当者コードが不正 |
| 1028 | CC送信先メールアドレスが不正 |
| 1029 | 郵送先宛名1が不正 |
| 1030 | 郵送先宛名2が不正 |
| 1031 | 郵送先宛名3が不正 |
| 1032 | 郵送先郵便番号が不正 |
| 1033 | 郵送先都道府県が不正 |
| 1034 | 郵送先市区町村番地が不正 |
| 1035 | 郵送先建物名が不正 |
| 1036 | 郵送宛先利用フラグが不正 |
| 1037 | 請求先部署登録に失敗 |
| 1038 | 請求先が存在しない |
| 1039 | 請求先部署コードが不正 |
| 1040 | 合計請求書用請求先コードが不正 |
| 1041 | 合計請求書用請求先部署番号が不正 |
| 1042 | 合計請求書用請求先部署コードが不正 |
| 1043 | 請求書テンプレートコードが不正 |
| 1044 | 親請求先部署が存在しない |
| 1045 | 既に他の親請求先部署が存在する親請求先部署を指定しています |
| 1046 | 請求先部署の登録ステータスが不正 |
| 1049 | 合計請求書用請求先部署番号と合計請求書用請求先部署コードは同時に指定できません |
| 1050 | 親請求先部署は承認依頼中のため使用できません |
| 1051 | 請求先決済情報コードが不正 |
| 1052 | 請求先決済情報名が不正 |
| 1053 | 請求先部署売掛金補助科目コードが不正 |
| 1054 | 請求先部署前受金補助科目コードが不正 |
| 1055 | 請求先部署仮受金補助科目コードが不正 |