支払先登録更新招待API
1. 概要
支払先の登録・更新を行う。招待方法が指定された場合は招待まで行う。
2. アクセス仕様
| 項目 | 内容 |
|---|---|
| プロトコル | HTTPS |
| メソッド | POST |
| ポート番号 | 443 |
| タイムアウト | 300秒 |
| URL | https://api.infomart.co.jp/v1/invoice/buyer/customers |
| インターフェースバージョン | v1 |
3. リクエスト(HTTPS GET, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
| パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
|---|---|---|---|---|---|
| response_type | レスポンス形式 | 文字列 | 4 | ○ | "json" "xml" |
| customers[] | 支払先 | 配列 | - | ○ | |
| private_cust_cd | 支払先コード | 文字列 | 15 | ○ | |
| user_email | メールアドレス | 文字列 | 100 | ||
| user_name_1 | 氏 | 文字列 | 15 | ||
| user_name_2 | 名 | 文字列 | 15 | ||
| user_name_kana_1 | 氏(カナ) | 文字列 | 20 | ||
| user_name_kana_2 | 名(カナ) | 文字列 | 20 | ||
| corp_genuine_id | 法人番号 | 数字 | 13 | ||
| company_name_org | 会社名 | 文字列 | 60 | △ | 支払先が未登録時は必須。 「長さ・範囲」はバイト表記。 全半角の英数記号カナが入力可能。 全角は2バイト、半角は1バイトとして最大長を評価する。 会社名と事業所・営業所名を両方指定する場合は合計60バイト以下で指定する。 |
| company_name_kana_org | 会社名(カナ) | 文字列 | 100 | 「長さ・範囲」はバイト表記。 全半角の英数記号カナが入力可能。 全角は2バイト、半角は1バイトとして最大長を評価する。 会社名(カナ)と事業所・営業所名(カナ)を両方指定する場合は合計100バイト以下で指定する。 |
|
| base_name | 事業所・営業所名 | 文字列 | 60 | 「長さ・範囲」はバイト表記。 全半角の英数記号カナが入力可能。 全角は2バイト、半角は1バイトとして最大長を評価する。 会社名と事業所・営業所名を両方指定する場合は合計60バイト以下で指定する。 |
|
| base_name_kana | 事業所・営業所名(カナ) | 文字列 | 100 | 「長さ・範囲」はバイト表記。 全半角の英数記号カナが入力可能。 全角は2バイト、半角は1バイトとして最大長を評価する。 会社名(カナ)と事業所・営業所名(カナ)を両方指定する場合は合計100バイト以下で指定する。 |
|
| zip | 会社郵便番号 | 文字列 | 8 | 「XXX-XXXX」の形式で指定する。 | |
| address1 | 会社住所 | 文字列 | 100 | 会社住所と会社住所(番地、建物名等)で合計100文字以下で指定する。 | |
| address2 | 会社住所（番地、建物名） | 文字列 | 100 | 会社住所と会社住所(番地、建物名等)で合計100文字以下で指定する。 | |
| phone | 会社電話番号 | 文字列 | 15 | 「XXXXX-XXXX-XXXX」の形式で指定する。 ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。 |
|
| fax | 会社FAX番号 | 文字列 | 15 | 「XXXXX-XXXX-XXXX」の形式で指定する。 ハイフンで区切り、各桁数以内(5桁、4桁、4桁)で指定する。 |
|
| private_user_employee_no | 受取担当者社員コード | 文字列 | 15 | 受取担当者社員コードと受取担当者名の両方を設定した場合、両方の条件に該当する社員を設定します。 | |
| private_user_name | 受取担当者名 | 文字列 | 30 | 受取担当者社員コードと受取担当者名の両方を設定した場合、両方の条件に該当する社員を設定します。 | |
| invite_method | 招待方法 | 文字列 | 1 | 下記のいずれかを指定された場合のみ支払先を招待する。 1:メールで招待 2:印刷で招待 4:FAXで招待 5:メール＋FAX ※）APIより自動で招待を行いたい場合は、メールアドレスも設定する。メールアドレスが未入力の場合、印刷またはFAXでの招待となり画面で招待のオペレーションを行う必要がある。 |
4. レスポンス (JSON/XML, UTF-8)
※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）
成功時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | null固定。 |
失敗時
| 要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
|---|---|---|---|---|
| result | 処理結果 | 文字列 | ○ | |
| error_list[] | エラーリスト | 配列 | ○ | |
| error_item | エラー項目 | 文字列 | ||
| error_code | エラーコード | 文字列 | ○ | |
| error_detail | エラー内容 | 文字列 | ○ |
5. 処理詳細
5.1. API実行権限チェック
API利用ユーザーが有料会員かチェックを行う。
受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。
5.2. リクエストチェック
リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。
5.3. 支払先の登録・更新処理
リクエストで指定された支払先が未登録の場合、登録を行う。
リクエストで指定された支払先が登録済の場合、更新を行う（変更がある場合のみ）。
5.4. 支払先の招待処理
リクエストで指定された支払先が登録済でかつ未招待の場合、招待を行う。
5.5. 処理結果送信
処理結果をJSON/XML形式で返却する。
6. 備考・補足
特になし。
