TDM

公共分类（外部API)

原查询客户列表

基本信息

Path： /api/executor/v1/custApi/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
custNameOrCode	string	非必须	名称或编码
unifiedCode	string	非必须	社会信用统一编码
address	string	非必须	地址
pageSize	number	非必须	每页大小
pageNum	number	非必须	页数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	null	非必须
├─ custCode	string	非必须	客户编码
├─ custName	string	非必须	客户名称
├─ unifiedCode	string	非必须	社会信用统一编码
├─ address	string	非必须	地址
├─ status	number	非必须	状态
traceId	string	非必须
total	number	非必须

原查询客户列表全部（不分页）

基本信息

Path： /api/executor/v1/custApi/listAll

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
tenCode	否		租户编码

Body

名称	类型	是否必须	备注
custNameOrCode	string	非必须	名称或编码
unifiedCode	string	非必须	社会信用统一编码
address	string	非必须	地址
pageSize	number	非必须	每页大小
pageNum	number	非必须	页数

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	null	非必须
├─ custCode	string	非必须	客户编码
├─ custName	string	非必须	客户名称
├─ unifiedCode	string	非必须	社会信用统一编码
├─ address	string	非必须	地址
├─ status	number	非必须	状态
traceId	string	非必须
total	number	非必须

查询租户关联企业列表

基本信息

Path： /api/tdm/v1/affiliates/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
page	否		分页
size	否		分页

Body

名称	类型	是否必须	备注
kind	string	非必须	关联类型， cusomer(客户),executor(执行公司),provider(供应商)
code	string	非必须	自定义code
name	string	非必须	自定义name
rightCode	string	非必须	系统内部编码
tenantCode	string	非必须	租户唯一编码
status	boolean	非必须	状态：true, 有效 false，禁用 null: 不限定
binding	boolean	非必须	是否完成邀请绑定
caName	string	非必须	企业统一认证名称
caCode	string	非必须	企业统一认证编码

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	number	必须	id
├─ kind	string	必须	类别
├─ code	string	必须	编码
├─ name	string	必须	名称
├─ caCode	null	必须	社会统一信用代码
├─ caName	null	必须	企业名称
├─ rightCode	string,null	必须	统一编码
├─ tenantCode	string	必须	租户编码
traceId	string	非必须
total	number	非必须

查询租户关联企业列表(内部SDK)

基本信息

Path： /sdk/v1/affiliates/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	备注
page	否	分页
size	否	分页
tenantCode	是	租户编码

Body

名称	类型	是否必须	备注
kind	string	非必须	关联类型， cusomer(客户),executor(执行公司),provider(供应商)
code	string	非必须	自定义code
name	string	非必须	自定义name
rightCode	string	非必须	系统内部编码
tenantCode	string	非必须	租户唯一编码
status	boolean	非必须	状态：true, 有效 false，禁用 null: 不限定

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	number	必须	id
├─ kind	string	必须	类别
├─ code	string	必须	编码
├─ name	string	必须	名称
├─ caCode	null	必须	社会统一信用代码
├─ caName	null	必须	企业名称
├─ rightCode	string,null	必须	统一编码
├─ tenantCode	string	必须	租户编码
traceId	string	非必须
total	number	非必须

页面接口（所有接口作废）

关联企业-受邀并新增编辑关联企业

基本信息

Path： /api/tdm/v1/affiliates/accept/invite

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
code	是	邀请码	邀请码
entrance	是	入口	入口，customer executor provider

Body

名称	类型	是否必须	备注	其他信息
editId	number	非必须	新增时，editId 为null，编辑时，editId有值
kind	string	必须	类别
provider	object	非必须
├─ isActive	boolean	非必须	是否激活
├─ code	string	非必须	编码，新增时传值
├─ name	string	非必须	名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ phone	string	非必须	联系电话
├─ otherContact	object []	非必须	其他联系人	item 类型: object
├─ contact	string	必须
├─ phone	string	必须
customer	string	非必须	客户
executor	string	非必须	执行公司

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

关联企业-受邀验证

基本信息

Path： /api/tdm/v1/affiliates/accept/invite

Method： GET

接口描述：

l 发邀租户在受邀租户的本列表（【客户】、【供应商】或【执行公司】）中不存在，且没有绑定关系。页面为新增关联企业
l 发邀租户在受邀租户的本列表（【客户】、【供应商】或【执行公司】）中存在，且没有完成绑定邀请。完成输入编码时，展示名称、地址等信息，可以直接修改。绑定到本条数据。
l 发邀租户在受邀租户的本列表（【客户】、【供应商】或【执行公司】）中存在，已经完成绑定邀请。直接展示名称、地址等信息，可以直接修改。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
code	是	邀请码	邀请码
entrance	是	入口	入口，customer executor provider

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ kind	string	非必须	类别
├─ kindName	null	非必须
├─ caName	null	非必须	企业实名
├─ caCode	null	非必须	企业统一信用代码
├─ inviteTenantKind	string	必须	发邀租户类别
├─ protocol	object []	必须	协议列表	item 类型: object
├─ name	string	必须	协议名称
├─ url	string	必须	协议地址
├─ customer	null	非必须	客户
├─ executor	null	非必须	执行公司
├─ provider	object	非必须	供应商
├─ isActive	boolean	非必须	是否激活
├─ code	string	非必须	编码
├─ name	string	非必须	名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ phone	string	非必须	联系电话
├─ otherContact	object []	非必须	其他联系人	item 类型: object
├─ contact	string	必须
├─ phone	string	必须
traceId	string	非必须

新增关联企业

基本信息

Path： /api/tdm/v1/affiliates/create

Method： POST

接口描述：

根据 kind 内容，对应的 customer、executor、provider部分有值。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
kind	string	非必须	类别
customer	object	非必须	客户
├─ code	string	非必须	编码
├─ name	string	非必须	名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ phone	string	非必须	联系电话
├─ otherContact	object []	非必须	其他联系人	item 类型: object
├─ contact	string	必须	联系人
├─ phone	string	必须	联系电话
executor	string	必须	执行公司，结构同客户
provider	string	必须	供应商，结构同客户

返回数据

名称	类型	是否必须	默认值	备注	其他信息

编辑关联企业

基本信息

Path： /api/tdm/v1/affiliates/{id}/edit

Method： POST

接口描述：

根据 kind 内容，对应的 customer、executor、provider部分有值。
ohterContent 是否修改都需要传入参数，
修改条目只传 phone 一个值，phoneText、phoneSalt为null，
其他不修改的条目传拉取到的 phone、phoneText、phoneSalt

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	备注	其他信息
kind	string	非必须	类别
customer	object	非必须	客户
├─ isActive	boolean	非必须	是否激活
├─ name	string	非必须	名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ phone	string	非必须	联系电话
├─ otherContact	object []	非必须	其他联系人	item 类型: object
├─ contact	string	必须	联系人
├─ phone	string	必须	联系电话
├─ phoneText	string	必须	加密电话
├─ phoneSalt	string	必须	加密方式
executor	string	必须	执行公司，结构同客户
provider	string	必须	供应商，结构同客户

返回数据

名称	类型	是否必须	默认值	备注	其他信息

邀请关联企业

基本信息

Path： /api/tdm/v1/affiliates/{id}/invite

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ existInvite	boolean	非必须	是否已有邀请
├─ code	string	非必须	邀请码
├─ inviteOperation	string	非必须	邀请方法
traceId	string	非必须

客户关联

创建客户

基本信息

Path： /api/tdm/v1/affiliate/customer/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
code	string	必须	客户编码
name	string	必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机,带"*"不更新
extendProp2	string	非必须	扩展属性，待定

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系电话密钥
├─ contactPhoneShow	string	非必须	联系电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

删除客户

基本信息

Path： /api/tdm/v1/affiliate/customer/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	18

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

启用/禁用客户

基本信息

Path： /api/tdm/v1/affiliate/customer/status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
status	是	true
id	是	24

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

更新客户

基本信息

Path： /api/tdm/v1/affiliate/customer/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
id	是	24

Body

名称	类型	是否必须	备注
code	string	非必须	客户编码
name	string	非必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机
extendProp2	string	非必须	扩展属性

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	公司认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系人电话
├─ contactPhoneShow	string	非必须	联系人电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

获取客户列表

基本信息

Path： /api/tdm/v1/affiliate/customer/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
search	否	条件
page	否	0, 表示首页
size	否

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	number	必须	企业关联ID
├─ kind	string	必须	企业类型
├─ code	string	必须	企业编码
├─ name	string	必须	企业名称
├─ caCode	null	必须	社会统一编码
├─ caName	null	必须	企业认证名称
├─ address	string	必须	地址
├─ contact	string	必须	联系人
├─ contactPhone	string	必须	获取手机号的密钥
├─ contactPhoneShow	string	必须	显示使用的手机号
├─ rightCode	string	必须	系统统一编码
├─ status1	boolean	必须	状态
├─ binding	string	必须	绑定状态，未邀请，邀请中，已绑定
traceId	string	非必须
total	number	非必须

获取客户详情

基本信息

Path： /api/tdm/v1/affiliate/customer/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	企业ID
├─ kind	string	非必须	类型
├─ code	string	非必须	编码
├─ name	string	非必须	名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	手机号密钥
├─ contactPhoneShow	string	非必须	显示的手机号
├─ rightCode	string	非必须	系统编码
├─ extendProp2	object	非必须	扩展属性
traceId	string	非必须

获取联系人电话号码

基本信息

Path： /api/tdm/v1/affiliate/customer/contact/phone

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	18
phone	是	1901013005439286935

返回数据

名称	类型	是否必须	默认值	备注	其他信息

执行公司关联

创建执行公司_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
code	string	必须	客户编码
name	string	必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机,带"*"不更新
extendProp2	string	非必须	扩展属性，待定

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系电话密钥
├─ contactPhoneShow	string	非必须	联系电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

删除执行公司_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	18

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

启用/禁用执行公司_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
status	是	true
id	是	24

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

更新执行公司_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
id	是	24

Body

名称	类型	是否必须	备注
code	string	非必须	客户编码
name	string	非必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机
extendProp2	string	非必须	扩展属性

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	公司认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系人电话
├─ contactPhoneShow	string	非必须	联系人电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

获取执行公司列表_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
search	否	条件
page	是	0, 表示首页
size	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	number	必须	企业关联ID
├─ kind	string	必须	企业类型
├─ code	string	必须	企业编码
├─ name	string	必须	企业名称
├─ caCode	null	必须	社会统一编码
├─ caName	null	必须	企业认证名称
├─ address	string	必须	地址
├─ contact	string	必须	联系人
├─ contactPhone	string	必须	获取手机号的密钥
├─ contactPhoneShow	string	必须	显示使用的手机号
├─ rightCode	string	必须	系统统一编码
├─ status1	boolean	必须	状态
├─ binding	string	必须	绑定状态，未邀请，邀请中，已绑定
traceId	string	非必须
total	number	非必须

获取执行公司详情_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	企业ID
├─ kind	string	非必须	类型
├─ code	string	非必须	编码
├─ name	string	非必须	名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	手机号密钥
├─ contactPhoneShow	string	非必须	显示的手机号
├─ rightCode	string	非必须	系统编码
├─ extendProp2	object	非必须	扩展属性
traceId	string	非必须

获取联系人电话号码_copy

基本信息

Path： /api/tdm/v1/affiliate/executor/contact/phone

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	18
phone	是	1901013005439286935

返回数据

名称	类型	是否必须	默认值	备注	其他信息

供应商关联

创建供应商_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
code	string	必须	客户编码
name	string	必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机,带"*"不更新
extendProp2	string	非必须	扩展属性，待定

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系电话密钥
├─ contactPhoneShow	string	非必须	联系电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

删除供应商_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	18

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

启用/禁用供应商_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
status	是	true
id	是	24

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

更新供应商_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
id	是	24

Body

名称	类型	是否必须	备注
code	string	非必须	客户编码
name	string	非必须	客户名称
address	string	非必须	地址
contact	string	非必须	联系人
contactPhoneShow	string	非必须	联系人手机
extendProp2	string	非必须	扩展属性

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	客户ID
├─ kind	string	非必须	类型
├─ code	string	非必须	客户编码
├─ name	string	非必须	客户名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	公司认证名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	联系人电话
├─ contactPhoneShow	string	非必须	联系人电话显示
├─ rightCode	string	非必须	系统编码
├─ extendProp2	null	非必须	扩展属性
traceId	string	非必须

获取供应商列表_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
search	否	条件
page	是	0, 表示首页
size	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object []	非必须		item 类型: object
├─ id	number	必须	企业关联ID
├─ kind	string	必须	企业类型
├─ code	string	必须	企业编码
├─ name	string	必须	企业名称
├─ caCode	null	必须	社会统一编码
├─ caName	null	必须	企业认证名称
├─ address	string	必须	地址
├─ contact	string	必须	联系人
├─ contactPhone	string	必须	获取手机号的密钥
├─ contactPhoneShow	string	必须	显示使用的手机号
├─ rightCode	string	必须	系统统一编码
├─ status1	boolean	必须	状态
├─ binding	string	必须	绑定状态，未邀请，邀请中，已绑定
traceId	string	非必须
total	number	非必须

获取供应商详情_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	企业ID
├─ kind	string	非必须	类型
├─ code	string	非必须	编码
├─ name	string	非必须	名称
├─ caCode	null	非必须	社会统一编码
├─ caName	null	非必须	企业名称
├─ address	string	非必须	地址
├─ contact	string	非必须	联系人
├─ contactPhone	string	非必须	手机号密钥
├─ contactPhoneShow	string	非必须	显示的手机号
├─ rightCode	string	非必须	系统编码
├─ extendProp2	object	非必须	扩展属性
traceId	string	非必须

获取联系人电话号码_copy

基本信息

Path： /api/tdm/v1/affiliate/provider/contact/phone

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	18
phone	是	1901013005439286935

返回数据

名称	类型	是否必须	默认值	备注	其他信息

通用邀请流程

获取邀请协议

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/sender/protocol

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
id	是	11	主数据ID

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ templateId	number	非必须	模板ID
├─ templateVersion	number	非必须	模板版本
├─ content	string	非必须	提示内容
├─ protocols	object []	非必须		item 类型: object
├─ code	string	必须	协议编码
├─ version	string	必须	协议版本
├─ name	string	必须	协议名称
├─ uri	string	必须	协议地址（外链打开）
traceId	string	非必须

签发邀请码

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/sender/code/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
id	是	11	主数据ID
templateId	是	2	邀请模板
templateVersion	是	2	邀请模板版本

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ code	string	非必须	邀请码
├─ content	string	非必须	提示内容
├─ expiredAt	string	非必须	邀请码过期时间
traceId	string	非必须

获取邀请信息（已邀请）

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/sender/code/info

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
id	是	11	主数据ID

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ code	string	非必须	邀请码
├─ content	string	非必须	提示内容
├─ expiredAt	string	非必须	邀请码过期时间
traceId	string	非必须

作废邀请码

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/sender/code/invalid

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
id	是	11	主数据ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
traceId	string	非必须

获取受邀帮助信息

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/accept/start/help

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ content	string	非必须	提示内容
traceId	string	非必须

输入邀请码

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/accept/code/verify

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
code	是		邀请码

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ content	string	非必须	提示内容
├─ protocols	object []	非必须	协议	item 类型: object
├─ code	string	必须	协议编码
├─ version	string	必须	协议版本
├─ name	string	必须	协议名称
├─ uri	string	必须	协议地址
traceId	string	非必须

确认邀请协议

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/accept/protocol/confirm

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
code	是		邀请码

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ editCode	string	必须	修改和编辑码
├─ caCode	string	必须	发邀企业社会统一编码
├─ caName	string	必须	发邀企业名称
traceId	string	非必须

编辑主数据

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/accept/data/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
code	是		编辑码

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ content	string	非必须	提示的内容
traceId	string	非必须

查询主数据

基本信息

Path： /api/tdm/v1/affiliate/{kind}/invite/accept/data

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
kind	customer	customer, executor, provider ...

Query

参数名称	是否必须	示例	备注
code	是		主数据编码

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
data	object	非必须
├─ id	number	非必须	主数据ID
├─ kind	string	非必须	类型，忽略
├─ code	string	必须	主数据编码
├─ name	string	必须	主数据名称
├─ caCode	null	非必须	认证信息，忽略
├─ caName	null	非必须	认证信息，忽略
├─ address	null	非必须	地址
├─ contact	null	非必须	联系人
├─ contactPhone	null	非必须	联系人电话密钥
├─ contactPhoneShow	null	非必须	联系人电话显示
├─ rightCode	string	非必须	系统唯一编码
├─ extendProp2	null	非必须	扩展属性
├─ exist	boolean	非必须	数据是否存在
├─ bindable	boolean	非必须	数据能否绑定
traceId	string	非必须

总线

关联公司，code修改通知

基本信息

Path： /com_myfmes_mdm.tdm-affiliate-data-change

Method： POST

接口描述：

总线主题：com_myfmes_mdm.tdm-affiliate-data-change

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
id	number	非必须	数据主键
rightCode	string	非必须	系统统一编码
sid	string	非必须	sessionId
source	object	非必须
├─ code	string	非必须
├─ name	string	非必须
target	object	非必须
├─ code	string	非必须
├─ name	string	非必须
tenantCode	string	非必须	租户Code
traceId	string	非必须	追踪ID
kind	string	非必须	类型，customer, provider, executor

返回数据

名称	类型	是否必须	默认值	备注	其他信息

YAPI 接口文档

TDM

公共分类（外部API)

原查询客户列表

基本信息

请求参数

返回数据

原查询客户列表全部（不分页）

基本信息

请求参数

返回数据

查询租户关联企业列表

基本信息

请求参数

返回数据

查询租户关联企业列表(内部SDK)

基本信息

请求参数

返回数据

页面接口（所有接口作废）

关联企业-受邀并新增编辑关联企业

基本信息

请求参数

返回数据

关联企业-受邀验证

基本信息

请求参数

返回数据

新增关联企业

基本信息

请求参数

返回数据

编辑关联企业

基本信息

请求参数

返回数据

邀请关联企业

基本信息

请求参数

返回数据

客户关联

创建客户

基本信息

请求参数

返回数据

删除客户

基本信息

请求参数

返回数据

启用/禁用客户

基本信息

请求参数

返回数据

更新客户

基本信息

请求参数

返回数据

获取客户列表

基本信息

请求参数

返回数据

获取客户详情

基本信息

请求参数

返回数据

获取联系人电话号码

基本信息

请求参数

返回数据

执行公司关联

创建执行公司_copy

基本信息

请求参数

返回数据

删除执行公司_copy

基本信息

请求参数

返回数据

启用/禁用执行公司_copy

基本信息