仕入先情報更新
OpenAPI説明
当該APIは仕入先情報の更新に利用します。
リクエストURI
/api/openapi/suppliers
リクエスト形式
PUT
リクエスト例
{
"companyCode": "123",
"code": "123",
"name": "vendorName-01",
"halfKanaName": "VENDOR",
"businessRegistrationNumber": "T2201845125542",
"businessCategory": "1001",
"businessRegistrationDate": "2022-09-10",
"effectiveDate": "2020-12-12",
"status": "1001",
"legalRepresentative": "123",
"taxId": "012345",
"checkNetNo": "00008100",
"contact": {
"name": "xxx",
"phone": "07039842346",
"email": "502022222692@qq.com",
"fax": "123",
"address": "qqq",
"halfKanaAddress": "QQQ",
"postalCode": "456-123"
},
"remark": "xxx",
"description": "xxx",
"payeeLegalRepresentativeNumber": "1234567890123",
"externalKey": "GAIBU123456",
"allowTempBank": false,
"customFields": [
{
"fieldCode": "Test",
"value": "1"
}
],
"paymentTerm":"001" ,
"selectPaymentMethod":"N" ,
"paymentMethods":["code001","code002","code003"] ,
"defaultPaymentMethod": "code001"
}
リクエスト項目
項目名 | タイプ | 必須 | キー | 規則 | 説明 |
---|---|---|---|---|---|
companyCode | String | ○ | 最大50文字 | 会社コード | |
code | String | ○ | ○ | 最大50文字 | 仕入先コード 入力可能文字[アルファベット,数字,.,_-] |
name | String | ○ | 最大50文字 | 仕入先名称 | |
halfKanaName | String | 最大50文字 | 仕入先名称半角カナ | ||
businessRegistrationNumber | String | 最大14文字 | 事業者登録番号 | ||
businessCategory | Integer | 1001:課税事業者 1002:免税事業者 | 事業者区分 | ||
businessRegistrationDate | Date | 日付フォーマット:yyyy-MM-dd | 事業者登録日 | ||
effectiveDate | Date | 日付フォマット:yyyy-mm-dd | 利用開始日 | ||
status | String | 固定4文字 | ステータス 有効:1001(デフォルト) 無効:1002 | ||
legalRepresentative | String | 最大30文字 | 代表取締役 | ||
taxId | String | 最大30文字 | タックス登録番号 入力可能文字[アルファベット,数字] | ||
checkNetNo | String | 最大10文字 | でんさいNetNO. 入力可能文字[アルファベット,数字] | ||
contact | Contact | 連絡先情報 | |||
remark | String | 最大200文字 | 備考 | ||
description | String | 最大50文字 | 備考(検索用) | ||
allowTempBank | Boolean | 伝票で振込先のスポット入力 true:入力可能 false:入力不可 | |||
customFields | CustomField[] | 最大10個 | fieldCodeが重複不可 | ||
paymentTerm | String | 支払パターン | |||
selectPaymentMethod | String | 適用の支払方法 Y:全部(デフォルト) N:一部 | |||
paymentMethods | List | 支払方法 適用の支払方法が一部の場合のみ、更新する | |||
defaultPaymentMethod | String | デフォルト支払方法 | |||
payeeLegalRepresentativeNumber | String | 最大50文字 | 受取人法人番号(法人マイナンバー) | ||
externalKey | String | 最大50文字 | 外部キー |
Contact
項目名 | タイプ | 必須 | 規則 | 説明 |
---|---|---|---|---|
name | String | 最大30文字 | 連絡先 | |
phone | String | 最大20文字 | 連絡先電話 入力可能文字[数字,-] 例:090-1234-5678 09012345678 | |
String | 最大100文字 | メールアドレス | ||
fax | String | 最大20文字 | ファックス 入力可能文字[数字,-] 例:090-1234-5678 09012345678 | |
address | String | 最大200文字 | 住所 | |
halfKanaAddress | String | 最大200文字 | 住所半角カナ | |
postalCode | String | 最大10文字 | 郵便番号[数字,-] |
CustomField
パラメータ名 | タイプ | 必須 | キー | 規則 | 説明 |
---|---|---|---|---|---|
fieldCode | String | ○ | ○ | 最大50文字 | カスタマイズ項目コード |
value | String | 最大500文字 | カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です |
OpenAPIリターン例
成功例
{
"message": "success",
"key": "123412"
}
失敗例
{
"message": "指定した会社はステータスが無効になっているか、存在しません",
"errorCode": "121310"
}
項目説明
項目 | タイプ | 説明 |
---|---|---|
message | String | エラーメッセージを返す |
errorCode | String | エラーコードを返す |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
120003 | パラメータ:{0}は指定必須の項目です | |
0013 | パラメータ:{0}は{1}文字以内で指定してください | |
120016 | パラメータ:{0}は{1}文字で指定してください | |
120206 | 携帯番号の指定が正しくありません | |
120007 | 指定したコードに半角英数字、.(ピリオド)、_(アンダーバー)、-(ハイフン)以外の文字が含まれています | |
120210 | 指定したメールアドレスが正しくありません | |
120234 | 指定したファックスが正しくありません | |
120235 | パラメータ:{0}は半角英数字で指定してください | |
121711 | 指定したステータスが正しくありません | |
121704 | 仕入先情報が存在しません | |
121309 | カンパニーコードと登録したカンパニーコードが一致しません | |
121310 | 指定した会社はステータスが無効になっているか、存在しません | |
121751 | でんさいNetNO.は英数字を入力してください。 | |
121752 | 郵便番号が不正です。 | |
121753 | 日付が有効範囲外になっています | |
120247 | 仕入先拡張項目コードは空白してはいけません | |
120248 | 仕入先拡張項目コードは存在しません:{0} | |
120249 | 仕入先拡張項目コードは重複できません | |
120250 | 仕入先拡張項目の値は空白してはいけません | |
120251 | 仕入先拡張項目は最大10個まで設定可能です | |
6061006 | カスタマイズ項目:{0} の値は正しくありません | |
spd.5480.001 | {0}は半角カタカナのみで入力してください | |
SPD.13711.005 | デフォルトの支払方法は適用の支払方法範囲内にしてください | |
SPD.13711.006 | 適用の支払方法の値は正しくありません | |
SPD.13711.007 | 指定した支払方法:{0}は存在しませんまたは無効です | |
SPD.13711.008 | 適用の支払方法は一部の場合、支払方法は必須項目です | |
SPD.13711.009 | 指定した支払パターン:{0}は存在しませんまたは無効です | |
spd.13871.001 | {0}:{1}~{2}文字の範囲で入力してください | |
spd.18874.001 | 事業者区分の値は正しくありません | |
spd.18874.002 | 国税庁APIの呼び出しエラーが発生し、データ取得失敗しました | |
spd.18874.003 | 事業者登録番号は存在しません | |
spd.18874.004 | 課税事業者の場合、事業者登録番号を入力してください | |
spd.18874.005 | 免税事業者の場合、事業者登録番号は入力できません | |
spd.18874.006 | 事業者名称は国税庁に登録した名称と一致しません | |
spd.29931.001 | 半角【 a~z、A~Zの英字、0~9の数字 】を入力してください |