追加供应商
接口描述
此接口用于使用中间件同步追加供应商
请求URI
/api/openapi/suppliers
请求方式
POST
请求体示例
{
"companyCode": "123",
"typeCode": "777",
"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": "00009100",
"contact": {
"name": "xxx",
"phone": "07039842346",
"email": "123@qq.com",
"fax": "123",
"address": "qqq",
"halfKanaAddress": "QQQ",
"postalCode": "123-456"
},
"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 | 公司编码 | |
| typeCode | 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 | 否 | 付款方式 仅可选付款方式为N:部分时，更新 | ||
| defaultPaymentMethod | String | 否 | 默认付款方式 | ||
| payeeLegalRepresentativeNumber | String | 最大长度50 | 收款人法人编号 | ||
| externalKey | String | 最大长度50 | 外部Key |
Contact
| 字段名 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| name | String | 最大30文字 | 联系人 | |
| phone | String | 最大20文字 | 联系人电话 只可输入[数字,-] | |
| String | 最大100文字 | 联系人邮箱 | ||
| fax | String | 最大20文字 | 传真 | |
| address | String | 最大200文字 | 地址 | |
| halfKanaAddress | String | 最大200文字 | 地址半角假名 | |
| postalCode | String | 最大10文字 | 邮政编码[数字或-] |
CustomField
| 参数名 | 类型 | 必填 | 主键 | 约束 | 说明 |
|---|---|---|---|---|---|
| fieldCode | String | ○ | ○ | 最大长度 50 | 自定义字段编码 |
| value | String | 最大长度 500 | 自定义字段值，如果自定义字段设定为必填，则该值不可为空 |
接口返回示例
成功
{
"message": "success",
"key": "123412"
}
失败示例
{
"message": "公司不存在或已失效",
"errorCode": "121310"
}
字段说明
| 字段名称 | 类型 | 说明 |
|---|---|---|
| message | String | 返回信息说明 |
| errorCode | String | 返回错误码 |
错误代码
| errorCode | message | 说明 |
|---|---|---|
| 120003 | 缺少必填项:{0} | |
| 0013 | 参数:{0},最大长度{1} | |
| 120016 | 参数长度非法:{0}长度必须为{1}个字符 | |
| 120206 | 手机号不合法 | |
| 120007 | 编码不合法,包含非法字符 | |
| 120210 | Email不合法 | |
| 120234 | 传真格式不合法 | |
| 120235 | 参数：{0},不能输入字母或数字以外的字符 | |
| 121711 | 该供应商状态不合法 | |
| 121701 | 该供应商编码已存在 | |
| 121748 | 供应商类型编码不存在 | |
| 121309 | 公司Code与登录的公司Code不一致 | |
| 121310 | 公司不存在或已失效 | |
| 121749 | 供应商类型编码已禁用 | |
| 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的数字 】 |
更新供应商 →