customer/add
目录 |
1.接口说明
1.1接口描述
添加一个新客户(子表属性:addresses=>收货地址;bands=>银行账户;invoicecustomers=>开票单位;users=>相关员工;auths=>管理维度)
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
基础数据同步
3.接口调用说明
3.1请求说明
url | https://api.yonyouup.com/api/customer/add |
格式 | JSON |
https请求方式 | POST |
编码类型 | UTF-8 |
3.2url参数说明
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
from_account | string | 是 | 调用方id |
to_account | string | 是 | 提供方id |
app_key | string | 是 | 应用编码 |
token | string | 是 | api调用唯一识别码 |
tradeid | string | 是 | 交易唯一识别码,tradeid与biz_id只能传入一个 |
ds_sequence | number | 否 | 数据源序号(默认取应用的第一个数据源) |
biz_id | string | 是 | 上游id,需要保证biz_id与ERP主键唯一对应关系,tradeid与biz_id只能传入一个 |
sync | number | 否 | 0=异步新增(默认);1=同步新增; |
3.3请求体参数说明
参数 | 类型 | 参数路径 | 是否必填 | 描述 |
---|---|---|---|---|
code | string | 是 | 客户编码 | |
name | string | 是 | 客户名称 | |
abbrname | string | 否 | 客户简称 | |
sort_code | string | 否 | 所属分类码 | |
domain_code | string | 否 | 所属地区码 | |
industry | string | 否 | 所属行业 | |
contact | string | 否 | 联系人 | |
phone | string | 否 | 电话 | |
fax | string | 否 | 传真 | |
mobile | string | 否 | 手机 | |
devliver_site | string | 否 | 发货地址 | |
end_date | date | 否 | 停用日期 | |
memo | string | 否 | 备注 | |
ccusexch_name | string | 否 | 币种 | |
bcusdomestic | string | 否 | 国内 | |
bcusoverseas | string | 否 | 国外 | |
bserviceattribute | string | 否 | 服务 | |
self_define1 | string | 否 | 自定义项1 | |
self_define2 | string | 否 | 自定义项2 | |
self_define3 | string | 否 | 自定义项3 | |
self_define4 | string | 否 | 自定义项4 | |
self_define5 | string | 否 | 自定义项5 | |
self_define6 | string | 否 | 自定义项6 | |
self_define7 | string | 否 | 自定义项7 | |
self_define8 | string | 否 | 自定义项8 | |
self_define9 | string | 否 | 自定义项9 | |
self_define10 | string | 否 | 自定义项10 | |
self_define11 | string | 否 | 自定义项11 | |
self_define12 | string | 否 | 自定义项12 | |
self_define13 | string | 否 | 自定义项13 | |
self_define14 | string | 否 | 自定义项14 | |
self_define15 | string | 否 | 自定义项15 | |
self_define16 | string | 否 | 自定义项16 | |
ccuscode | string | addresses | 否 | 客户编码 |
caddcode | string | addresses | 否 | 收货地址编码 |
bdefault | boolean | addresses | 否 | 默认值(1/0) |
cdeliveradd | string | addresses | 否 | 收货地址 |
cenglishadd | string | addresses | 否 | 英文地址 |
cenglishadd2 | string | addresses | 否 | 英文地址2 |
cenglishadd3 | string | addresses | 否 | 英文地址3 |
cenglishadd4 | string | addresses | 否 | 英文地址4 |
cdeliverunit | string | addresses | 否 | 收货单位 |
clinkperson | string | addresses | 否 | 联系人 |
ccuscode | string | banks | 否 | 客户编码 |
caccountnum | string | banks | 否 | 银行账号 |
bdefault | boolean | banks | 否 | 默认值(1/0) |
cbank | string | banks | 否 | 所属银行编码 |
cbranch | string | banks | 否 | 开户银行 |
caccountname | string | banks | 否 | 账户名称 |
cCusPrinvince | string | banks | 否 | 省 |
cCusCity | string | banks | 否 | 市 |
cCusCBBDepId | string | banks | 否 | 机构号 |
cCusBranchId | string | banks | 否 | 联行号 |
cCusBranchIdSec | string | banks | 否 | 联行号II |
ccuscode | string | invoicecustomers | 否 | 客户编码 |
cinvoicecompany | string | invoicecustomers | 否 | 开票单位编码 |
bdefault | boolean | invoicecustomers | 否 | 默认值(1/0) |
ccuscode | string | users | 否 | 客户编码 |
user_id | string | users | 否 | 操作员编码 |
is_self | boolean | users | 否 | 相关或负责员工(true/false) |
ccuscode | string | auths | 否 | 客户编码 |
privilege_type | string | auths | 否 | 管理维度类型编码 |
privilege_id | string | auths | 否 | 管理维度编码 |
3.4请求示例
POST https://api.yonyouup.com/api/customer/add?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296&biz_id=0971&ds_sequence=1 POST 内容: { "customer":{ "code":"1000101", "name":"用友软件股份有限公司", "abbrname":"用友", "sort_code":"01", "contact":"宋明慧", "addresses":{ "ccuscode":"1000101", "caddcode":"012", "cdeliveradd":"北京市海淀区北清路68号", "bdefault":"1" }, "banks":[ { "ccuscode":"1000101", "cbank":"02", "cbranch":"招商银行双榆树支行", "caccountnum":"6225000099998888", "caccountname":"用友软件股份有限公司", "bdefault":"1" }, { "ccuscode":"1000101", "cbank":"03", "cbranch":"北京建行分行", "caccountnum":"62250987678890", "caccountname":"用友软件股份有限公司", "bdefault":"0" } ], "invoicecustomers":{ "ccuscode":"1000101", "cinvoicecompany":"1000101", "bdefault":"true" }, "users":{ "ccuscode":"1000101", "user_id":"demo5", "is_self":"true" }, "auths":{ "ccuscode":"1000101", "privilege_type":"0", "privilege_id":"0301" } } }
3.5返回参数说明
参数说明 | 类型 | 描述 |
---|---|---|
errcode | string | 错误码,0 为正常。 |
errmsg | string | 错误信息。 |
id | string | 新增成功后返回客户编码(与调用传入的编码一致)。 |
tradeid | string | 新增成功后返回交易唯一识别码 |
3.6正确返回示例
JSON示例:
{ "tradeid": "158f3f05730711e591c702004c4f4f50", "ping_after": "3", "url": "https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50" } 上述 api 请求返回信息表示建议客户端 3 秒钟后向 https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50 发送 GET 请求获取真正的 api 调用结果,结果格式如下: { "errcode" : "0", "errmsg" : "", "id" : "883", "tradeid" : "158f3f05730711e591c702004c4f4f50" }
3.7错误返回示例
application/json;charset=UTF-8 { "errcode" : "30021", "errmsg" : "此应用未上线" }