取引先情報追加
OpenAPI説明
当該APIは取引先情報の新規追加に利用します。
リクエストURI
/api/openapi/customer
リクエスト形式
POST
リクエスト例
{
"companyCode": "3",
"typeCode": "1",
"code": "1111",
"name": "取引先名",
"halfKanaName": "1",
"effectiveDate": "2024-02-01",
"isCounterparty": true,
"isPayer": true,
"payerCode": null,
"status": true,
"selectBankMethod": "1002",
"collectionTermCode": null,
"selectCollectionMethod": "Y",
"collectionMethods": null,
"defaultCollectionMethod": "1",
"tradingConditions": null,
"contact": {
"legalRepresentative": "11",
"name": "12345",
"phone": "9999999999",
"email": "2345@qq.com",
"fax": "12345678",
"address": "2323",
"halfKanaAddress": "23423434",
"postalCode": "213214",
"remark": "00000",
"remarkForInquiry": "00000000"
},
"principalDepartment": {
"departmentCode": "0219",
"phoneNumber": "66662222",
"address": "アドレス１",
"email": "66663333@function-test.com"
},
"principalUser": {
"employeeNo": "1016",
"phoneNumber": "66661111",
"email": "66661111@funxtionn.com"
},
"isPrintCompanySeal": false,
"customFields": []
}
リクエスト項目
| 項目名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| companyCode | String | ○ | ○ | 最大50文字 | 会社コード |
| typeCode | String | ○ | ○ | 最大50文字 | 取引先タイプコード |
| code | String | ○ | ○ | 最大50文字 | 取引先コード |
| name | String | ○ | 最大50文字 | 取引先名称 | |
| halfKanaName | String | 最大50文字 | 取引先名半角カナ | ||
| effectiveDate | Date | yyyy-mm-dd | 有効日 | ||
| isCounterparty | Boolean | 取引先フラグ | |||
| isPayer | Boolean | 請求先フラグ | |||
| payerCode | String | 最大50文字 | 請求先コード | ||
| status | Boolean | ステータス | |||
| selectBankMethod | String | 固定4文字 | 適用の口座情報 1001：会社から 1002：請求先から | ||
| collectionTermCode | String | 入金パターン 値セット「入金パータン」の値コード | |||
| selectCollectionMethod | String | 適用の入金方法 Y：全部(デフォルト) N：一部 | |||
| collectionMethods | List | 利用可の入金方法リスト | |||
| defaultCollectionMethod | String | デフォルトの入金方法コード | |||
| tradingConditions | String | 最大200文字 | 取引条件 | ||
| contact | Contact | 連絡先情報 | |||
| principalDepartment | PrincipalDepartment | 担当部門 | |||
| principalUser | PrincipalUser | 担当者 | |||
| isPrintCompanySeal | Boolean | 社印を印字する | |||
| customFields | CustomField[] | 最大10個 | fieldCodeが重複不可 |
Contact
| 字段名 | 类型 | 必須 | キー | 约束 | 说明 |
|---|---|---|---|---|---|
| legalRepresentative | String | 最大30文字 | 代表取締役 | ||
| name | String | 最大30文字 | 連絡先 | ||
| phone | String | 最大20文字 | 連絡先電話 | ||
| String | 最大100文字 | メールアドレス | |||
| fax | String | 最大20文字 | ファックス | ||
| postalCode | String | 最大10文字 | 郵便番号 | ||
| address | String | 最大200文字 | 住所 | ||
| halfKanaAddress | String | 最大200文字 | 住所（半角カナ） | ||
| remark | String | 最大200文字 | 備考 | ||
| remarkForInquiry | String | 最大50文字 | 備考（検索用） |
PrincipalDepartment
| 項目名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| departmentCode | String | ○ | 最大36文字 | 担当部門コード | |
| phoneNumber | String | ○ | 最大20文字 | 連絡先 担当部門値ある場合、入力必須 | |
| String | ○ | 最大100文字 | メールアドレス 担当部門値ある場合、入力必須 | ||
| address | String | ○ | 最大200文字 | 住所 担当部門値ある場合、入力必須 |
PrincipalUser
| 項目名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| employeeNo | String | ○ | 最大36文字 | 従業員番号 | |
| phoneNumber | String | ○ | 最大20文字 | 連絡先 担当部門値ある場合、入力必須 | |
| String | ○ | 最大100文字 | メールアドレス 担当部門値ある場合、入力必須 |
CustomField
| パラメータ名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| fieldCode | String | ○ | ○ | 最大50文字 | カスタマイズ項目コード |
| value | String | 最大500文字 | カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です |
OpenAPIリターン例
成功例
{
"message": "success",
"errorCode": "0000"
}
失敗例
{
"message": "指定した会社はステータスが無効になっているか、存在しません",
"errorCode": "121310"
}
項目説明
| 項目 | タイプ | 説明 |
|---|---|---|
| message | String | エラーメッセージを返す |
| errorCode | String | エラーコードを返す |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 120003 | パラメータ:{0}は指定必須の項目です | |
| 121310 | 指定した会社はステータスが無効になっているか、存在しません | |
| 121309 | カンパニーコードと登録したカンパニーコードが一致しません | |
| 0013 | パラメータ:{0}は{1}文字以内で指定してください | |
| SPD.26428.001 | 取引先タイプが存在しませんまた無効になっています | |
| 120007 | 指定したコードに半角英数字、.（ピリオド）、_（アンダーバー）、-（ハイフン）以外の文字が含まれています | |
| spd.5480.001 | {0}は半角カタカナのみで入力してください | |
| 6013009 | 日付フォーマットはyyyy-MM-ddです | |
| SPD.26428.002 | 請求先が存在しませんまた無効になっています | |
| SPD.26428.003 | 当該取引先が請求先ではありません | |
| SPD.26428.004 | 指定した取引先コードは既に存在しています | |
| SPD.26428.005 | 指定した適用の口座情報が正しくありません | |
| SPD.26428.006 | 入金パターンが存在しませんまた無効になっています | |
| SPD.26428.007 | 適用の入金方法の値は正しくありません | |
| SPD.26428.008 | {0}が存在しませんまた無効になっています | |
| SPD.26428.009 | 入金方法が存在しませんまた無効になっています | |
| SPD.26428.010 | デフォルト入金方法が一部の入金方法に存在しません | |
| SPD.26428.011 | 適用の入金方法は一部の場合、一部の入金方法は必須項目です | |
| 120206 | 携帯番号の指定が正しくありません | |
| 120210 | 指定したメールアドレスが正しくありません | |
| 120234 | 指定したファックスが正しくありません | |
| 121752 | 郵便番号が不正です。 | |
| SPD.26428.012 | 担当部門が存在しませんまた無効になっています | |
| SPD.26428.013 | 担当者が存在しませんまた無効になっています | |
| 6061006 | カスタマイズ項目:{0} の値は正しくありません | |
| SPD.26428.customField.001 | 取引先拡張項目は最大10個まで設定可能です | |
| SPD.26428.customField.002 | 取引先拡張項目コードは空白してはいけません | |
| SPD.26428.customField.003 | 取引先拡張項目コードは存在しません:{0} | |
| SPD.26428.customField.004 | 取引先拡張項目コードは重複できません | |
| SPD.26428.customField.005 | 取引先拡張項目の値は空白してはいけません |
取引先情報更新 →