服务地址
| 地址 | 说明 |
|---|---|
| http://localhost:8080 | 开发环境 |
| https://api.leadwaycloud.com | 测试环境 |
接口详情
PUT
/api/supplierReview/template/updateVersion/{id}
调用方法
PUT /api/supplierReview/template/updateVersion/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ||
| ruleId | query | 否 | integer(int64) | 规则ID | 1 |
| name | query | 否 | string | 名称 | 1 |
| content | query | 否 | string | 内容 | 1 |
| active | query | 否 | boolean | 是否可用 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
PUT
/api/supplierReview/template/update/{id}
调用方法
PUT /api/supplierReview/template/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewTemplateDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewTemplateDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| ruleId | integer(int64) | 否 | 规则ID | 1 |
| name | string | 否 | 名称 | "1" |
| content | string | 否 | 内容 | "1" |
| active | boolean | 否 | 是否可用 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/supplierReview/rule/update/{id}
调用方法
PUT /api/supplierReview/rule/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewRuleDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewRuleDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 编号 | "1" |
| frequency | string | 否 | 频率(月、季度、年) | "1" |
| supplierId | string | 否 | 供应商ID 多个用,分隔 | "1" |
| contractId | string | 否 | 合同ID 多个用,分隔 | "1" |
| contractAmount | string | 否 | 合同金额 | "1" |
| currencyId | integer(int64) | 否 | 货币符号ID | |
| exchangeRate | number(double) | 否 | 兑换本公司汇率 | |
| merge | boolean | 否 | 兑换本公司汇率 | |
| triggerDays | boolean | 否 | 频率触发日(1-31号) | |
| triggerMonth | boolean | 否 | 频率触发月(本月CURRENT_MONTH、次月FOLLOWING_MONTH) | |
| note | string | 否 | 备注 | "1" |
| active | boolean | 否 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/supplierReview/data/update/{id}
调用方法
PUT /api/supplierReview/data/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewDataDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewDataDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | "1" |
| note | string | 否 | 备注 | "1" |
| appendData | string | 否 | 附加参数 | "1" |
| status | string | 否 | 状态 | "1" |
| result | string | 否 | 结果 | "1" |
| purchaseData | string | 否 | 采购数据 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/supplierContactPerson/update/{id}
调用方法
PUT /api/supplierContactPerson/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierContactPersonDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmSupplierContactPersonDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | 供应商联系人主键ID | |
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| mobile | string | 否 | 手机 | |
| type | string | 是 | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| typeOfWork | string | 否 | 工种:高空作业、电工等 | |
| age | string | 否 | 年龄 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| attachmentsRequired | string | 否 | 必要附件 | |
| idCard | string | 否 | 身份证 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson | 否 |
PUT
/api/supplierCategory/update/{id}
调用方法
PUT /api/supplierCategory/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: SupplierCategoryDTO$UpdateDTO com.leadwaycloud.crm.model.dto.SupplierCategoryDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | |
| name | string | 否 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory | 否 |
PUT
/api/supplierCategory/unbind
调用方法
PUT /api/supplierCategory/unbind参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| rmPartnerSupplierCategoryDTO | query | 是 | PartnerSupplierCategoryDTO$AddDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/supplierCategory/bind
调用方法
PUT /api/supplierCategory/bind参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| addPartnerSupplierCategoryDTO | query | 是 | PartnerSupplierCategoryDTO$AddDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/supplier/update/{id}
调用方法
PUT /api/supplier/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 供应商ID |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmSupplierDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | 供应商ID | |
| name | string | 否 | 名称 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "个人" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| shortName | string | 否 | 简称 | |
| source | string | 否 | 来源 | |
| sourceInfo | string | 否 | 来源补充信息 | |
| settlementMethod | string | 否 | 结算类型 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| code | string | 否 | 编号 | |
| distributionMode | string | 否 | 经销模式 | |
| enterpriseType | string | 否 | 企业类型 | |
| operatingStatus | string | 否 | 经营状态 | |
| abnormalStatusReason | string | 否 | 经营状态异常说明 | |
| version | string | 否 | 版本号 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredAddress | string | 否 | 注册地址 | |
| extensionInfo | string | 否 | 供应商额外属性 | |
| cooperationStatus | string | 否 | 供应商合作状态 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| contact | ContactDTO$UpdateDTO | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| financePaymentBankList | FinancePaymentBankDTO$UpdateDTO[] | 否 | 付款信息集合 | |
| epo | boolean | 否 | 是否开启E订单 | |
| restrictType | string | 否 | 采购限制类型 | |
| restrictQty | number(double) | 否 | 采购限制数量 | |
| orderExpiredClose | boolean | 否 | 是否开启订单过期关闭 | |
| orderValidity | integer(int32) | 否 | 订单有效期 | |
| supplierCategoryIdList | integer(int64) | 否 | 供应商分组Id集合 | |
| supplierContactPersonList | CrmSupplierContactPersonDTO$AddDTO | 否 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
PUT
/api/supplier/outlets/update/{id}
调用方法
PUT /api/supplier/outlets/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID |
请求体
Content-Type: application/json 必填: 是 类型: SupplierOutletsDTO$UpdateDTO com.leadwaycloud.crm.model.dto.SupplierOutletsDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | "银泰城永辉超市" |
| code | string | 是 | 标识 | "...." |
| type | string | 是 | 类型 | "SELF_PICKUP_OUTLETS" |
| contactPerson | string | 是 | 联络人 | "张三" |
| phone | string | 是 | 电话 | "13888888888" |
| address | string | 否 | 地址 | "银泰城负一楼永辉超市" |
| status | string | 是 | 状态 | "ACTIVE" |
| latLon | string | 是 | 经纬度（纬度,经度） | "104.064737,30.547256" |
| openingTime | LocalTime | 否 | ||
| closingTime | LocalTime | 否 | ||
| image | string | 否 | 图片 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/producer/update/{id}
调用方法
PUT /api/producer/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmProducerDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmProducerDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| status | string | 是 | 状态 | |
| dependency | string | 否 | 属地 | |
| updateContractDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmProducer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
PUT
/api/memberTypeUpgradeRule/update/{id}
调用方法
PUT /api/memberTypeUpgradeRule/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeUpgradeRuleDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberTypeUpgradeRuleDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| online | boolean | 否 | 是否上线 | true |
| upgradeRuleDetailDTOList | MemberTypeUpgradeRuleDetailDTO[] | 否 | 规则 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeUpgradeRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
PUT
/api/memberTypeBuyRule/update/{id}
调用方法
PUT /api/memberTypeBuyRule/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeBuyRuleDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberTypeBuyRuleDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 购买活动名称 | |
| currentMemberTypeId | integer(int64) | 否 | 当前的会员类型ID | 1 |
| buyMemberTypeId | integer(int64) | 否 | 购买的会员类型 | 1 |
| validDay | integer(int32) | 否 | 有效日(在会员成为该类型多少天后，需还原为变更前的类型。未设置则表示永久) | |
| startDate | string(date) | 是 | 开始日期 | |
| endDate | string(date) | 是 | 结束时间 | |
| online | boolean | 是 | 是否上线 | true |
| memberTypeBuyRuleGiftDTOList | MemberTypeBuyRuleGiftDTO[] | 否 | 赠送详情 | |
| memberBuyRuleTenderDTOList | MemberBuyRuleTenderDTO[] | 否 | 支付规则 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
PUT
/api/memberType/update/{id}
调用方法
PUT /api/memberType/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberTypeDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| system | boolean | 否 | 系统默认 | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
PUT
/api/member/updateType/{id}
调用方法
PUT /api/member/updateType/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeChangeDTO com.leadwaycloud.crm.model.dto.MemberTypeChangeDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| typeId | integer(int64) | 是 | 会员类型ID | 1 |
| remark | string | 是 | 备注 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
PUT
/api/member/updateType-buy/{id}/{buyRuleId}
调用方法
PUT /api/member/updateType-buy/{id}/{buyRuleId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
| buyRuleId | path | 是 | integer(int64) | 购买晋级规则ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
PUT
/api/member/update/{id}
调用方法
PUT /api/member/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| otherBarcode | string | 否 | 第三方条码 | |
| status | string | 否 | 状态 | "1" |
| name | string | 否 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 否 | 性别 | "男" |
| appId | string | 否 | appId | |
| birthday | string(date) | 否 | 生日 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机 | |
| image | string | 否 | 图片 | |
| openId | string | 否 | openId | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| customerId | integer(int64) | 否 | 客户ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
PUT
/api/member/update-member-bind-status
调用方法
PUT /api/member/update-member-bind-status参数
无
请求体
Content-Type: application/json 必填: 是 类型: UpdateMemberBindDTO com.leadwaycloud.crm.model.dto.UpdateMemberBindDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| openId | string | 是 | openId | |
| status | string | 是 | 绑定状态（BOUND:绑定、UNBIND：解绑） |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberOpenRef com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberOpenRef
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberOpenRef | 否 |
PUT
/api/member/member-bind
调用方法
PUT /api/member/member-bind参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberBindDTO com.leadwaycloud.crm.model.dto.MemberBindDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| name | string | 是 | 名称 | |
| redisKey | string | 是 | redisKey | |
| openId | string | 是 | openId | |
| verifyCode | string | 是 | 验证码 | |
| appId | string | 是 | appId | |
| sex | string | 是 | 性别（com.leadwaycloud.common.enums.databaseEnum.SexEnum） | "0" |
| mobilePhone | string | 是 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源（com.leadwaycloud.common.enums.databaseEnum.SourceCodeEnum） | "ERP" |
| autoRegister | boolean | 是 | 自主注册 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
PUT
/api/member/feedback/update/{id}
调用方法
PUT /api/member/feedback/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberFeedBackDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberFeedBackDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户Id | |
| companyId | integer(int64) | 是 | 公司Id | |
| memberId | string | 是 | 会员Id | |
| channel | string | 否 | 渠道 | |
| feedbackTypeEnum | string | 是 | 反馈类型 | |
| originId | integer(int64) | 否 | 对应类型事物ID | |
| subject | string | 否 | 主题 | |
| comment | string | 否 | 留言 | |
| replys | string | 否 | 回复 | |
| status | string | 是 | 状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberFeedback com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
PUT
/api/member/discount/update/{id}
调用方法
PUT /api/member/discount/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeBuyDiscountDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberTypeBuyDiscountDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| discValue | number(double) | 是 | 折扣值 | |
| status | string | 是 | 状态 | "DRAFT" |
| channel | string | 是 | 促销渠道 | |
| startTime | string(date) | 是 | 开始时间 | |
| endTime | string(date) | 是 | 结束时间 | |
| buyRuleId | integer(int64) | 是 | 付费规则ID | 1 |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyDiscount com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
PUT
/api/member/contact/update/{id}
调用方法
PUT /api/member/contact/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberContactDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberContactDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| countryId | integer(int64) | 否 | 国家ID | 1 |
| provinceId | integer(int64) | 否 | 省、直辖市 | 1 |
| cityId | integer(int64) | 否 | 城市 | 1 |
| areaId | integer(int64) | 否 | 区、县 | 1 |
| streetId | integer(int64) | 否 | 街道 | 1 |
| address | string | 否 | 详细地址 | |
| mobile | string | 否 | 手机 | |
| name | string | 否 | 名称 | |
| def | boolean | 否 | 默认 | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberContact com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact | 否 |
PUT
/api/member/account/update
调用方法
PUT /api/member/account/update参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberAccountDTO com.leadwaycloud.crm.model.dto.MemberAccountDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| memberId | integer(int64) | 否 | 会员ID | 1 |
| memberBarcode | string | 否 | 会员编号 | "002391117577753472" |
| accountTypeId | integer(int64) | 是 | 账户类型ID | 1 |
| type | string | 是 | 会员账户权益变更类型（com.leadwaycloud.common.enums.databaseEnum.MemberAccountUpdateEnum） | "INCREASE" |
| changeValue | number(double) | 否 | 变更值 | |
| remark | string | 否 | 备注 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccount com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccount | 否 |
PUT
/api/member/account/updateStatus/{accountId}
调用方法
PUT /api/member/account/updateStatus/{accountId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| accountId | path | 是 | integer(int64) | 账户ID | 0 |
请求体
Content-Type: application/json 必填: 是 类型: string
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccount com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccount | 否 |
PUT
/api/member/account/type/update/{id}
调用方法
PUT /api/member/account/type/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: MemberAccountTypeDTO$UpdateDTO com.leadwaycloud.crm.model.dto.MemberAccountTypeDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号(只允许字母) | "BALANCE" |
| name | string | 是 | 名称 | |
| changeValue | number(double) | 否 | 兑换值 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccountType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType | 否 |
PUT
/api/delivery-person/update/{id}
调用方法
PUT /api/delivery-person/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 配送人员ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: DeliveryPersonDTO$UpdateDTO com.leadwaycloud.crm.model.dto.DeliveryPersonDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | string | 否 | 类型 | |
| name | string | 否 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司 | |
| externalCode | string | 否 | 外部编码 | |
| note | string | 否 | 备注 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/delivery-carrier/update/{id}
调用方法
PUT /api/delivery-carrier/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 载体ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: DeliveryCarrierDTO$UpdateDTO com.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| identifier | string | 否 | 车牌号 | |
| note | string | 否 | 备注 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/customerContactPerson/update/{id}
调用方法
PUT /api/customerContactPerson/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: CustomerContactPersonDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CustomerContactPersonDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| status | string | 否 | 状态 | |
| code | string | 否 | 编号 | |
| externalCode | string | 否 | 外部编号 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson | 否 |
PUT
/api/customerCategory/update/{id}
调用方法
PUT /api/customerCategory/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmCustomerCategoryDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmCustomerCategoryDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | |
| name | string | 否 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory | 否 |
PUT
/api/customerCategory/unbind
调用方法
PUT /api/customerCategory/unbind参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| rmPartnerSupplierCategoryDTO | query | 是 | CrmCustomerCategoryDTO$AddPartnerCustomerCategoryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/customerCategory/bind
调用方法
PUT /api/customerCategory/bind参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| addPartnerSupplierCategoryDTO | query | 是 | CrmCustomerCategoryDTO$AddPartnerCustomerCategoryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/customer/update/{id}
调用方法
PUT /api/customer/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: CrmCustomerDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmCustomerDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 类型(公司/个人) | |
| status | string | 否 | 状态 | |
| image | string | 否 | 图片 | |
| contact | ContactDTO$UpdateDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$UpdateDTO[] | 否 | 发票抬头 | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| extensionInfo | string | 否 | 额外属性 | |
| certificationAuditStatus | string | 否 | 认证审核状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
PUT
/api/crm/roleApplyRecord/update
调用方法
PUT /api/crm/roleApplyRecord/update参数
无
请求体
Content-Type: application/json 必填: 是 类型: RoleApplyRecordDTO$UpdateDTO com.leadwaycloud.crm.model.dto.RoleApplyRecordDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| recordId | integer(int64) | 是 | 申请记录ID | 1 |
| userId | integer(int64) | 是 | 用户ID | 1 |
| requestData | RoleApplyRequestParamDTO$UpdateDTO | 是 | ||
| status | string | 否 | 状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmRoleApplyRecord com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmRoleApplyRecord | 否 |
PUT
/api/carrier/update/{id}
调用方法
PUT /api/carrier/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmCarrierDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmCarrierDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "PERSONAL" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| contactDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/carrier/carrierUnbindCompany
调用方法
PUT /api/carrier/carrierUnbindCompany参数
无
请求体
Content-Type: application/json 必填: 是 类型: AgentCompanyDTO$AddDTO com.leadwaycloud.crm.model.dto.AgentCompanyDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 否 | 公司Id集合 | |
| businessId | integer(int64) | 否 | 代理商ID,承运商Id |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/agent/update/{id}
调用方法
PUT /api/agent/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: CrmAgentDTO$UpdateDTO com.leadwaycloud.crm.model.dto.CrmAgentDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "PERSONAL" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| contactDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/agent/agentUnbindCompany
调用方法
PUT /api/agent/agentUnbindCompany参数
无
请求体
Content-Type: application/json 必填: 是 类型: AgentCompanyDTO$AddDTO com.leadwaycloud.crm.model.dto.AgentCompanyDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 否 | 公司Id集合 | |
| businessId | integer(int64) | 否 | 代理商ID,承运商Id |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/address/updateStatus
调用方法
PUT /api/address/updateStatus参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddressDTO$UpdateStatusDTO com.leadwaycloud.crm.model.dto.AddressDTO$UpdateStatusDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| addressIdList | integer(int64)[] | 是 | 地址ID集合 | |
| status | string | 是 | 状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/address/updateDef/{id}
调用方法
PUT /api/address/updateDef/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 地址ID | 0 |
| def | query | 是 | boolean |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
PUT
/api/address/update/{id}
调用方法
PUT /api/address/update/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
Content-Type: application/json 必填: 是 类型: AddressDTO$UpdateDTO com.leadwaycloud.crm.model.dto.AddressDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 否 | 详细地址 | |
| mobile | string | 否 | 手机 | |
| receiver | string | 否 | 收件人 | |
| externalCode | string | 否 | 外部编号 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/supplierReview/template/add
调用方法
POST /api/supplierReview/template/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewTemplateDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewTemplateDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| ruleId | integer(int64) | 是 | 规则ID | 1 |
| name | string | 否 | 名称 | "1" |
| content | string | 否 | 内容 | "1" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
POST
/api/supplierReview/rule/add
调用方法
POST /api/supplierReview/rule/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewRuleDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewRuleDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 编号 | "1" |
| frequency | string | 否 | 频率(月、季度、年) | "1" |
| supplierId | string | 否 | 供应商ID 多个用,分隔 | "1" |
| contractId | string | 否 | 合同ID 多个用,分隔 | "1" |
| contractAmount | string | 否 | 合同金额 | "1" |
| currencyId | integer(int64) | 否 | 货币符号ID | |
| exchangeRate | number(double) | 否 | 兑换本公司汇率 | |
| merge | boolean | 否 | 兑换本公司汇率 | |
| triggerDays | boolean | 否 | 频率触发日(1-31号) | |
| triggerMonth | boolean | 否 | 频率触发月(本月CURRENT_MONTH、次月FOLLOWING_MONTH) | |
| note | string | 否 | 备注 | "1" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewRule | 否 |
POST
/api/supplierReview/data/add
调用方法
POST /api/supplierReview/data/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierReviewDataDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmSupplierReviewDataDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | |
| templateId | integer(int64) | 是 | 评审模板ID | |
| templateVersion | string | 是 | 评审模板版本 | |
| ruleId | integer(int64) | 是 | 规则ID | |
| name | string | 否 | 名称 | |
| purchaseData | string | 否 | 采购数据 | |
| appendData | string | 否 | 附加参数 | |
| note | string | 否 | 附加参数 | |
| status | string | 否 | 状态 | |
| result | string | 否 | 结果 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewData com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewData | 否 |
POST
/api/supplierContactPerson/add
调用方法
POST /api/supplierContactPerson/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierContactPersonDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmSupplierContactPersonDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| mobile | string | 否 | 手机 | |
| type | string | 是 | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| typeOfWork | string | 否 | 工种:高空作业、电工等 | |
| age | integer(int32) | 否 | 年龄 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| attachmentsRequired | string | 否 | 必要附件 | |
| idCard | string | 否 | 身份证 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierContactPerson com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson[] | 否 | 返回数据 |
POST
/api/supplierCategory/add
调用方法
POST /api/supplierCategory/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: SupplierCategoryDTO$AddDTO com.leadwaycloud.crm.model.dto.SupplierCategoryDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory | 否 |
POST
/api/supplier/updateSupplierCompanyStatus
调用方法
POST /api/supplier/updateSupplierCompanyStatus参数
无
请求体
Content-Type: application/json 必填: 是 类型: SupplierCompanyStatusDTO$UpdateDTO com.leadwaycloud.crm.model.dto.SupplierCompanyStatusDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| relationIdList | integer(int64)[] | 是 | 绑定关系ID集合 | |
| status | string | 是 | 状态 | "ACTIVE" |
| settlementMethod | string | 是 | 供应商结算类型-爱达 | |
| cooperationStatus | string | 是 | 供应商合作状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/supplier/supplierDistribute
调用方法
POST /api/supplier/supplierDistribute参数
无
请求体
Content-Type: application/json 必填: 是 类型: SupplierDistributeDTO$AddDTO com.leadwaycloud.crm.model.dto.SupplierDistributeDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 是 | 公司ID集合 | |
| supplierIdList | integer(int64)[] | 是 | 供应商ID集合 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/supplier/outlets/add
调用方法
POST /api/supplier/outlets/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: SupplierOutletsDTO$AddDTO com.leadwaycloud.crm.model.dto.SupplierOutletsDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| name | string | 是 | 名称 | "银泰城永辉超市" |
| code | string | 是 | 标识 | "...." |
| type | string | 是 | 类型 | "SELF_PICKUP_OUTLETS" |
| contactPerson | string | 是 | 联络人 | "张三" |
| phone | string | 是 | 电话 | "13888888888" |
| address | string | 否 | 地址 | "银泰城负一楼永辉超市" |
| status | string | 是 | 状态 | "ACTIVE" |
| latLon | string | 是 | 经纬度（纬度,经度） | "104.064737,30.547256" |
| openingTime | LocalTime | 否 | ||
| closingTime | LocalTime | 否 | ||
| image | string | 否 | 图片 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |
POST
/api/supplier/import/{merchantId}/{companyId}/{type}
调用方法
POST /api/supplier/import/{merchantId}/{companyId}/{type}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int64) | 商户号ID | |
| companyId | path | 是 | integer(int64) | 当前门店ID | |
| type | path | 是 | string | 类型 | |
| file | query | 是 | string(binary) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/supplier/export/{type}
调用方法
POST /api/supplier/export/{type}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| type | path | 是 | string | 类型 |
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmSupplierDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmSupplierDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/supplier/associationCarrier/{id}
调用方法
POST /api/supplier/associationCarrier/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 供应商ID |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| (array) | integer(int64)[] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/supplier/add
调用方法
POST /api/supplier/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmSupplierDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmSupplierDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| settlementMethod | string | 否 | 结算类型 | |
| shortName | string | 否 | 简称 | |
| source | string | 否 | 来源 | |
| sourceInfo | string | 否 | 来源补充信息 | |
| distributionMode | string | 否 | 经销模式 | |
| enterpriseType | string | 否 | 企业类型 | |
| operatingStatus | string | 否 | 经营状态 | |
| abnormalStatusReason | string | 否 | 经营状态异常说明 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredAddress | string | 否 | 注册地址 | |
| status | string | 否 | 状态 | "DELETE" |
| origin | string | 否 | 来源 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| extensionInfo | string | 否 | 供应商额外属性 | |
| cooperationStatus | string | 是 | 供应商合作状态 | |
| supplierCategoryIdList | integer(int64)[] | 否 | 供应商分组Id集合 | |
| contact | ContactDTO$AddDTO | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| financePaymentBankList | FinancePaymentBankDTO$AddDTO[] | 否 | 供应商付款信息集合 | |
| supplierContactPersonList | CrmSupplierContactPersonDTO$AddDTO[] | 否 | 供应商联系人集合 | |
| epo | boolean | 否 | 是否开启E订单 | |
| restrictType | string | 否 | 采购限制类型 | |
| restrictQty | number(double) | 否 | 采购限制数量 | |
| orderExpiredClose | boolean | 否 | 是否开启订单过期关闭 | |
| orderValidity | integer(int32) | 否 | 订单有效期 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
POST
/api/producer/import/{merchantId}/{companyId}
调用方法
POST /api/producer/import/{merchantId}/{companyId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int64) | ||
| companyId | path | 是 | integer(int64) | ||
| file | query | 是 | string(binary) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/producer/export
调用方法
POST /api/producer/export参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmProducerDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmProducerDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmProducerDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/producer/add
调用方法
POST /api/producer/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmProducerDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmProducerDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| dependency | string | 否 | 属地 | |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmProducer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
POST
/api/partner/add
调用方法
POST /api/partner/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: PartnerDTO$AddDTO com.leadwaycloud.crm.model.dto.PartnerDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| supplier | PartnerDTO$AddSupplierDTO | 否 | ||
| producer | PartnerDTO$AddProducerDTO | 否 | ||
| agent | PartnerDTO$AddAgentDTO | 否 | ||
| carrier | PartnerDTO$AddCarrierDTO | 否 | ||
| customer | PartnerDTO$AddCustomerDTO | 否 | ||
| member | PartnerDTO$AddMemberDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$AddDTO[] | 否 | 添加发票抬头集合 | |
| financePaymentBankList | FinancePaymentBankDTO$AddDTO[] | 否 | 添加付款信息集合 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |
POST
/api/memberTypeUpgradeRule/add
调用方法
POST /api/memberTypeUpgradeRule/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeUpgradeRuleDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberTypeUpgradeRuleDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 所属商户ID | 1 |
| name | string | 是 | 名称 | |
| online | boolean | 是 | 是否上线 | true |
| upgradeRuleDetailDTOList | MemberTypeUpgradeRuleDetailDTO[] | 是 | 规则 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeUpgradeRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
POST
/api/memberTypeBuyRule/add
调用方法
POST /api/memberTypeBuyRule/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeBuyRuleDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberTypeBuyRuleDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 所属商户ID | 1 |
| name | string | 是 | 购买活动名称 | |
| currentMemberTypeId | integer(int64) | 是 | 当前的会员类型ID | 1 |
| buyMemberTypeId | integer(int64) | 是 | 购买的会员类型 | 1 |
| validDay | integer(int32) | 否 | 有效日(在会员成为该类型多少天后，需还原为变更前的类型。未设置则表示永久) | |
| startDate | string(date) | 是 | 开始日期 | |
| endDate | string(date) | 是 | 结束时间 | |
| online | boolean | 是 | 是否上线 | true |
| memberTypeBuyRuleGiftDTOList | MemberTypeBuyRuleGiftDTO[] | 否 | 赠送详情 | |
| memberBuyRuleTenderDTOList | MemberBuyRuleTenderDTO[] | 是 | 支付规则 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
POST
/api/memberType/add
调用方法
POST /api/memberType/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberTypeDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | |
| code | string | 是 | 编号 | |
| description | string | 否 | 描述 | |
| system | boolean | 否 | 是否是系统创建角色 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
POST
/api/member/member-register
调用方法
POST /api/member/member-register参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberBindDTO com.leadwaycloud.crm.model.dto.MemberBindDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| name | string | 是 | 名称 | |
| redisKey | string | 是 | redisKey | |
| openId | string | 是 | openId | |
| verifyCode | string | 是 | 验证码 | |
| appId | string | 是 | appId | |
| sex | string | 是 | 性别（com.leadwaycloud.common.enums.databaseEnum.SexEnum） | "0" |
| mobilePhone | string | 是 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源（com.leadwaycloud.common.enums.databaseEnum.SourceCodeEnum） | "ERP" |
| autoRegister | boolean | 是 | 自主注册 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
POST
/api/member/import-member/{merchantId}/{companyId}
调用方法
POST /api/member/import-member/{merchantId}/{companyId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int64) | ||
| companyId | path | 是 | integer(int64) | ||
| file | query | 是 | string(binary) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/member/feedback/add
调用方法
POST /api/member/feedback/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberFeedBackDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberFeedBackDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户Id | |
| companyId | integer(int64) | 是 | 公司Id | |
| memberId | string | 是 | 会员Id | |
| channel | string | 否 | 渠道 | |
| feedbackTypeEnum | string | 是 | 反馈类型 | |
| originId | integer(int64) | 否 | 对应类型事物ID | |
| subject | string | 否 | 主题 | |
| comment | string | 否 | 留言 | |
| replys | string | 否 | 回复 | |
| status | string | 是 | 状态 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberFeedback com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
POST
/api/member/export-member
调用方法
POST /api/member/export-member参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.MemberDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | MemberDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/member/discount/add
调用方法
POST /api/member/discount/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberTypeBuyDiscountDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberTypeBuyDiscountDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | |
| discValue | number(double) | 是 | 折扣值 | |
| status | string | 是 | 状态 | "AVAILABLE" |
| channel | string | 是 | 促销渠道 | |
| startTime | string(date) | 是 | 开始时间 | |
| endTime | string(date) | 是 | 结束时间 | |
| buyRuleId | integer(int64) | 是 | 付费规则ID | 1 |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyDiscount com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
POST
/api/member/contact/add
调用方法
POST /api/member/contact/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberContactDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberContactDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| memberId | integer(int64) | 是 | 会员ID | 1 |
| countryId | integer(int64) | 是 | 国家ID | 1 |
| provinceId | integer(int64) | 是 | 省、直辖市 | 1 |
| cityId | integer(int64) | 是 | 城市 | 1 |
| areaId | integer(int64) | 是 | 区、县 | 1 |
| streetId | integer(int64) | 否 | 街道 | 1 |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| name | string | 是 | 名称 | |
| def | boolean | 否 | 默认 | false |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberContact com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact | 否 |
POST
/api/member/add
调用方法
POST /api/member/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| otherBarcode | string | 否 | 第三方条码 | |
| openId | string | 否 | openId | |
| name | string | 是 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 是 | 性别 | "0" |
| appId | string | 否 | appId | |
| birthday | string(date) | 否 | 生日 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源 | "ERP" |
| memberTypeId | integer(int64) | 是 | 会员类型 | 1 |
| firstName | string | 否 | 姓 | "1" |
| lastName | string | 否 | 名 | "1" |
| barcode | string | 否 | ||
| customerId | integer(int64) | 否 | 客户ID | |
| accountTypeCodeList | string[] | 否 | 开通账户编号 | |
| origin | string | 否 | 来源 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
POST
/api/member/account/type/add
调用方法
POST /api/member/account/type/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: MemberAccountTypeDTO$AddDTO com.leadwaycloud.crm.model.dto.MemberAccountTypeDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| code | string | 是 | 编号(只允许字母) | "BALANCE" |
| name | string | 是 | 名称 | |
| changeValue | number(double) | 否 | 兑换值 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccountType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType | 否 |
POST
/api/member/account/batchAppendMemberAccountEquity/{merchantId}/{companyId}
调用方法
POST /api/member/account/batchAppendMemberAccountEquity/{merchantId}/{companyId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int64) | 公司ID | 0 |
| companyId | path | 是 | integer(int64) | ||
| file | query | 是 | string(binary) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/mallCustomer/mallCustomerCertification/{customerId}/{contactPersonId}
调用方法
POST /api/mallCustomer/mallCustomerCertification/{customerId}/{contactPersonId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| customerId | path | 是 | integer(int32) | 客户ID | 0 |
| contactPersonId | path | 是 | integer(int32) | 联系人ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/delivery-person/export
调用方法
POST /api/delivery-person/export参数
无
请求体
Content-Type: application/json 必填: 是 类型: DeliveryPersonDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.DeliveryPersonDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | DeliveryPersonDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/delivery-person/add
调用方法
POST /api/delivery-person/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: DeliveryPersonDTO$AddDTO com.leadwaycloud.crm.model.dto.DeliveryPersonDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | string | 是 | 类型 | |
| name | string | 是 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司 | |
| externalCode | string | 否 | 外部编码 | |
| note | string | 否 | 备注 | |
| companyId | integer(int64) | 否 | 公司ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmDeliveryPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmDeliveryPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmDeliveryPerson | 否 |
POST
/api/delivery-carrier/export
调用方法
POST /api/delivery-carrier/export参数
无
请求体
Content-Type: application/json 必填: 是 类型: DeliveryCarrierDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | DeliveryCarrierDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/delivery-carrier/add
调用方法
POST /api/delivery-carrier/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: DeliveryCarrierDTO$AddDTO com.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyId | integer(int64) | 否 | 公司ID | |
| type | string | 否 | 载体类型，默认CAR | |
| identifier | string | 是 | 车牌号 | |
| note | string | 否 | 备注 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmDeliveryCarrier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmDeliveryCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmDeliveryCarrier | 否 |
POST
/api/customerContactPerson/add
调用方法
POST /api/customerContactPerson/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CustomerContactPersonDTO$AddDTO com.leadwaycloud.crm.model.dto.CustomerContactPersonDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| customerId | integer(int64) | 是 | 客户Id | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| status | string | 否 | 状态 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| code | string | 否 | 编号 | |
| origin | string | 否 | 来源 | |
| externalCode | string | 否 | 外部编号 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson | 否 |
POST
/api/customerCategory/add
调用方法
POST /api/customerCategory/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmCustomerCategoryDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmCustomerCategoryDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory | 否 |
POST
/api/customer/import/{merchantId}/{companyId}
调用方法
POST /api/customer/import/{merchantId}/{companyId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int32) | 商户ID | 0 |
| companyId | path | 是 | integer(int32) | 公司ID | 1 |
| file | query | 是 | string(binary) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/customer/export
调用方法
POST /api/customer/export参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmCustomerDTO$QueryDTO com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmCustomerDTO$QueryDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmCustomerDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
响应
状态码: 200 说明: OK
无
POST
/api/customer/add
调用方法
POST /api/customer/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmCustomerDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmCustomerDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| origin | string | 否 | 来源 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| status | string | 否 | 状态 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| extensionInfo | string | 否 | 额外属性 | |
| certificationAuditStatus | string | 否 | 认证审核状态 | |
| contact | ContactDTO$AddDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$AddDTO[] | 否 | 发票抬头集合 | |
| contactPersonList | CustomerContactPersonDTO$AddDTO[] | 否 | 客户联系人集合 | |
| receiveAddressList | AddressDTO$AddDTO[] | 否 | 收货地址集合 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
POST
/api/crm/workflow/callback
调用方法
POST /api/crm/workflow/callback参数
无
请求体
Content-Type: application/json 必填: 是 类型: CallbackDTO com.leadwaycloud.crm.plug.workflow.model.CallbackDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | string | 否 | 业务状态 | |
| submitUserId | string | 否 | 提交人ID | |
| businessKey | string | 否 | 流程KEY(老业务KEY) | |
| businessId | string | 是 | 业务ID | |
| taskId | string | 否 | 节点ID | |
| body | string | 是 | 业务数据 | |
| businessTypeKey | string | 否 | 流程KEY(新业务KEY) | |
| key | string | 否 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/crm/roleApplyRecord/add
调用方法
POST /api/crm/roleApplyRecord/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: RoleApplyRecordDTO$AddDTO com.leadwaycloud.crm.model.dto.RoleApplyRecordDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| typeList | string | 否 | 类型 | "[\"SUPPLIER\"]" |
| string | 是 | 邮箱 | "kunliang.zeng@leadwaycloud.com" | |
| pwd | string | 否 | 密码 | "MD5(pwd)" |
| name | string | 是 | 用户名称 | "kunliang.zeng" |
| language | string | 是 | 系统语言 | "zh_CN" |
| image | string | 否 | 图片 | "xxxxx" |
| requestData | RoleApplyRequestParamDTO$UpdateDTO | 是 | ||
| applyType | string | 是 | CRM角色申请类型 | |
| origin | string | 否 | 来源 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmRoleApplyRecord com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmRoleApplyRecord | 否 |
POST
/api/crm/open/storePoint/shell/updateSupplier/{merchantId}
调用方法
POST /api/crm/open/storePoint/shell/updateSupplier/{merchantId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: ShellSPSupplierDTO[] com.leadwaycloud.crm.shell.model.dto.ShellSPSupplierDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| (array) | ShellSPSupplierDTO[] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/crm/open/storePoint/shell/deleteSupplier/{merchantId}
调用方法
POST /api/crm/open/storePoint/shell/deleteSupplier/{merchantId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: string[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| (array) | string[] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/crm/open/storePoint/shell/addSupplier/{merchantId}
调用方法
POST /api/crm/open/storePoint/shell/addSupplier/{merchantId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: ShellSPSupplierDTO[] com.leadwaycloud.crm.shell.model.dto.ShellSPSupplierDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| (array) | ShellSPSupplierDTO[] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/carrier/carrierBindCompany
调用方法
POST /api/carrier/carrierBindCompany参数
无
请求体
Content-Type: application/json 必填: 是 类型: AgentCompanyDTO$AddDTO com.leadwaycloud.crm.model.dto.AgentCompanyDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 否 | 公司Id集合 | |
| businessId | integer(int64) | 否 | 代理商ID,承运商Id |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/carrier/associationSupplier/{id}
调用方法
POST /api/carrier/associationSupplier/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| (array) | integer(int64)[] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/carrier/add
调用方法
POST /api/carrier/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmCarrierDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmCarrierDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |
POST
/api/agent/agentBindCompany
调用方法
POST /api/agent/agentBindCompany参数
无
请求体
Content-Type: application/json 必填: 是 类型: AgentCompanyDTO$AddDTO com.leadwaycloud.crm.model.dto.AgentCompanyDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 否 | 公司Id集合 | |
| businessId | integer(int64) | 否 | 代理商ID,承运商Id |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
POST
/api/agent/add
调用方法
POST /api/agent/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: CrmAgentDTO$AddDTO com.leadwaycloud.crm.model.dto.CrmAgentDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmAgent com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmAgent
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmAgent | 否 |
POST
/api/address/add
调用方法
POST /api/address/add参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddressDTO$AddDTO com.leadwaycloud.crm.model.dto.AddressDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| partnerId | integer(int64) | 否 | CRM关系ID | |
| name | string | 是 | 名称 | |
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| receiver | string | 是 | 收件人 | |
| def | boolean | 否 | 是否默认地址 | |
| type | string | 是 | 类型 | |
| externalCode | string | 否 | 外部编号 | |
| origin | string | 否 | 来源 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |
GET
/api/supplierReview/template/page
调用方法
GET /api/supplierReview/template/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| ruleId | query | 否 | integer(int64) | 规则ID | 1 |
| name | query | 否 | string | 名称 | 1 |
| active | query | 否 | boolean | 是否可用 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
GET
/api/supplierReview/template/get/{id}/{version}
调用方法
GET /api/supplierReview/template/get/{id}/{version}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 模板ID | |
| version | path | 是 | string | 版本 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
GET
/api/supplierReview/rule/page
调用方法
GET /api/supplierReview/rule/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| name | query | 否 | string | 名称 | 1 |
| code | query | 否 | string | 编号 | 1 |
| active | query | 否 | boolean |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewRule com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewRule | 否 |
GET
/api/supplierReview/rule/get/{id}
调用方法
GET /api/supplierReview/rule/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 模板ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewRule | 否 |
GET
/api/supplierReview/data/page
调用方法
GET /api/supplierReview/data/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| name | query | 否 | string | 名称 | 1 |
| status | query | 否 | string | 状态 | 1 |
| result | query | 否 | string | 结果 | 1 |
| startTime | query | 否 | string(date-time) | 开始时间 | |
| endTime | query | 否 | string(date-time) | 结束时间 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewData com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewData | 否 |
GET
/api/supplierReview/data/get/{id}
调用方法
GET /api/supplierReview/data/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 模板ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierReviewData com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewData | 否 |
GET
/api/supplierContactPerson/page
调用方法
GET /api/supplierContactPerson/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| supplierId | query | 否 | integer(int64) | 供应商ID | |
| type | query | 否 | string | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| merchantId | query | 否 | integer(int64) | 商户ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson | 否 |
GET
/api/supplierContactPerson/list
调用方法
GET /api/supplierContactPerson/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| supplierId | query | 否 | integer(int64) | 供应商ID | |
| type | query | 否 | string | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| merchantId | query | 否 | integer(int64) | 商户ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierContactPerson com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson[] | 否 | 返回数据 |
GET
/api/supplierContactPerson/get/{id}
调用方法
GET /api/supplierContactPerson/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson | 否 |
GET
/api/supplierCategory/list
调用方法
GET /api/supplierCategory/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | query | 否 | string | 编号 | |
| name | query | 否 | string | 名称 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| parentId | query | 否 | integer(int64) | CRM对象ID | |
| idChain | query | 否 | string | 完整的组织结构 | |
| images | query | 否 | string | 图片地址 | |
| merchantId | query | 是 | integer(int64) | 总部ID | 1 |
| externalCode | query | 否 | string | 外部编号 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory[] | 否 | 返回数据 |
GET
/api/supplierCategory/get/{id}
调用方法
GET /api/supplierCategory/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory | 否 |
GET
/api/supplier/querySupplierCompany
调用方法
GET /api/supplier/querySupplierCompany参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| queryDTO | query | 是 | SupplierCompanyStatusDTO$QueryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplierCompanyRelation com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCompanyRelation
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCompanyRelation[] | 否 | 返回数据 |
GET
/api/supplier/querySupplierByCategoryId/{categoryId}
调用方法
GET /api/supplier/querySupplierByCategoryId/{categoryId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| categoryId | path | 是 | integer(int64) | 供应商分类ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier[] | 否 | 返回数据 |
GET
/api/supplier/page
调用方法
GET /api/supplier/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| companyId | query | 否 | integer(int64) | 绑定公司ID | 1 |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 | |
| supplierCompanyRelationStatus | query | 否 | string | 供应商绑定状态 【 ACTIVE : DEACTIVATE : DELETE : 】 | "ACTIVE" |
| categoryId | query | 否 | integer(int64) | 供应商分组Id | |
| internal | query | 否 | boolean | 内外部区分 | |
| eligible | query | 否 | boolean | 是否合格供应商 | |
| cooperationStatus | query | 否 | string | 供应商合作状态 | |
| distributionMode | query | 否 | string | 经销模式 | |
| level | query | 否 | string | 等级 | |
| paymentRequire | query | 否 | string | 付款条件 | |
| goodsCategoryId | query | 否 | string | 产品分类ID | |
| origin | query | 否 | string | 来源 【 HANDLE : IMPORT : OPEN_API : WEB_POS : POS : APP : WECHAT_MALL : WECHAT_MINI_APPS : ERP : ECOMMERCE_PLATFORM : TRIPARTITE : 】 | |
| queryFinancePaymentBank | query | 否 | boolean | 是否查询银行付款信息 | |
| querySupplierContactPerson | query | 否 | boolean | 是否查询供应商联系人信息 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
GET
/api/supplier/outlets/page
调用方法
GET /api/supplier/outlets/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| queryDTO | query | 是 | SupplierOutletsDTO$QueryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SupplierOutletsListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.supplier.SupplierOutletsListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SupplierOutletsListVO | 否 |
GET
/api/supplier/outlets/get/{id}
调用方法
GET /api/supplier/outlets/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SupplierOutletsDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.supplier.SupplierOutletsDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SupplierOutletsDetailVO | 否 |
GET
/api/supplier/list
调用方法
GET /api/supplier/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| companyId | query | 否 | integer(int64) | 绑定公司ID | 1 |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 | |
| supplierCompanyRelationStatus | query | 否 | string | 供应商绑定状态 【 ACTIVE : DEACTIVATE : DELETE : 】 | "ACTIVE" |
| categoryId | query | 否 | integer(int64) | 供应商分组Id | |
| internal | query | 否 | boolean | 内外部区分 | |
| eligible | query | 否 | boolean | 是否合格供应商 | |
| cooperationStatus | query | 否 | string | 供应商合作状态 | |
| distributionMode | query | 否 | string | 经销模式 | |
| level | query | 否 | string | 等级 | |
| paymentRequire | query | 否 | string | 付款条件 | |
| goodsCategoryId | query | 否 | string | 产品分类ID | |
| origin | query | 否 | string | 来源 【 HANDLE : IMPORT : OPEN_API : WEB_POS : POS : APP : WECHAT_MALL : WECHAT_MINI_APPS : ERP : ECOMMERCE_PLATFORM : TRIPARTITE : 】 | |
| queryFinancePaymentBank | query | 否 | boolean | 是否查询银行付款信息 | |
| querySupplierContactPerson | query | 否 | boolean | 是否查询供应商联系人信息 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier[] | 否 | 返回数据 |
GET
/api/supplier/get/{id}
调用方法
GET /api/supplier/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 供应商ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
GET
/api/supplier/get/{companyId}/{id}
调用方法
GET /api/supplier/get/{companyId}/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| companyId | path | 是 | integer(int64) | 公司ID | |
| id | path | 是 | integer(int64) | 供应商ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmSupplier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
GET
/api/supplier/checkUnique
调用方法
GET /api/supplier/checkUnique参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| supplierCheckUniqueDTO | query | 是 | CrmSupplierDTO$SupplierCheckUniqueDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |
GET
/api/producer/page
调用方法
GET /api/producer/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| companyId | query | 否 | integer(int64) | 绑定公司ID | 1 |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmProducer com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
GET
/api/producer/list
调用方法
GET /api/producer/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| companyId | query | 否 | integer(int64) | 绑定公司ID | 1 |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmProducer com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer[] | 否 | 返回数据 |
GET
/api/producer/get/{id}
调用方法
GET /api/producer/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmProducer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
GET
/api/partner/query
调用方法
GET /api/partner/query参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| partnerIdList | query | 是 | integer(int64)[] |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: PartnerVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.PartnerVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PartnerVO[] | 否 | 返回数据 |
GET
/api/monitor/version
调用方法
GET /api/monitor/version参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
GET
/api/monitor/health
调用方法
GET /api/monitor/health参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
GET
/api/memberTypeUpgradeRule/page
调用方法
GET /api/memberTypeUpgradeRule/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| name | query | 否 | string | 名称 | |
| memberTypeName | query | 否 | string | 会员类型名称 | |
| online | query | 否 | boolean | 是否上线 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeUpgradeRule com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
GET
/api/memberTypeUpgradeRule/get/{id}
调用方法
GET /api/memberTypeUpgradeRule/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeUpgradeRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
GET
/api/memberTypeBuyRule/page
调用方法
GET /api/memberTypeBuyRule/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| name | query | 否 | string | 名称 | |
| buyTypeName | query | 否 | string | 购买的会员类型名称 | |
| currentMemberTypeId | query | 否 | integer(int64) | 当前会员类型ID | 1 |
| buyMemberTypeId | query | 否 | integer(int64) | 购买会员类型ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyRule com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
GET
/api/memberTypeBuyRule/get/{id}
调用方法
GET /api/memberTypeBuyRule/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyRule com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
GET
/api/memberType/page
调用方法
GET /api/memberType/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| name | query | 否 | string | 名称 | |
| code | query | 否 | string | 编号 | |
| merchantId | query | 是 | integer(int64) | 商户ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberType com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
GET
/api/memberType/list
调用方法
GET /api/memberType/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| name | query | 否 | string | 名称 | |
| code | query | 否 | string | 编号 | |
| merchantId | query | 是 | integer(int64) | 商户ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberType com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType[] | 否 | 返回数据 |
GET
/api/memberType/get/{id}
调用方法
GET /api/memberType/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
GET
/api/memberType/checkCode
调用方法
GET /api/memberType/checkCode参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | query | 是 | string | 类型编号 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |
GET
/api/member/typeUpdateLog/page/{memberId}
调用方法
GET /api/member/typeUpdateLog/page/{memberId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| memberId | path | 是 | integer(int64) | 会员ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeUpdateLog com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpdateLog | 否 |
GET
/api/member/shell/query-member/loyalty/qrcode
调用方法
GET /api/member/shell/query-member/loyalty/qrcode参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
| qrCode | query | 是 | string | 会员二维码 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LoyaltyMemberVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.shell.model.vo.LoyaltyMemberVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LoyaltyMemberVO | 否 |
GET
/api/member/shell/query-member/loyalty/phone
调用方法
GET /api/member/shell/query-member/loyalty/phone参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
| mobilePhone | query | 是 | string | 手机号 | 13888888888 |
| verificationCode | query | 是 | string | 验证码 | 643232 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: LoyaltyMemberVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.shell.model.vo.LoyaltyMemberVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LoyaltyMemberVO | 否 |
GET
/api/member/shell/query-member/login-verification-code
调用方法
GET /api/member/shell/query-member/login-verification-code参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户号ID | 1 |
| mobilePhone | query | 是 | string | 手机号 | 13888888888 |
| codeLength | query | 是 | integer(int32) | 验证码长度 | 6 |
| validTime | query | 是 | integer(int32) | 验证码有效时间(秒) | 60 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 |
GET
/api/member/query
调用方法
GET /api/member/query参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | query | 否 | integer(int64) | ID | 1 |
| barcode | query | 否 | string | 会员号 | |
| mobilePhone | query | 否 | string | 手机号 | |
| merchantId | query | 否 | integer(int64) | 商户ID | 1 |
| openId | query | 否 | string | openId |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
GET
/api/member/query-member-bind-status
调用方法
GET /api/member/query-member-bind-status参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| openId | query | 是 | string | openID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MemberBindStatusVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.MemberBindStatusVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MemberBindStatusVO | 否 |
GET
/api/member/page
调用方法
GET /api/member/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| status | query | 否 | string | 状态: ACTIVE:活跃的 LOCK:锁定的 | "ACTIVE" |
| name | query | 否 | string | 名称 | |
| mobilePhone | query | 否 | string | 手机 | |
| source | query | 否 | string | 会员来源 | |
| memberTypeName | query | 否 | string | 会员类型名称 | |
| barcode | query | 否 | string | 会员号 | |
| companyId | query | 否 | integer(int64) | 公司ID | 1 |
| memberTypeId | query | 否 | integer(int64) | 会员类型ID | 1 |
| otherBarcode | query | 否 | string | 第三方条码 | |
| idList | query | 否 | integer(int64) | 主键ID集合 | 1 |
| customerId | query | 否 | integer(int64) | 客户ID |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMember com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
GET
/api/member/member-login
调用方法
GET /api/member/member-login参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | query | 是 | string | appID | |
| jsCode | query | 是 | string | jsCode |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: MemberVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.MemberVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MemberVO | 否 |
GET
/api/member/getOpenId
调用方法
GET /api/member/getOpenId参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | query | 是 | string | appID | |
| jsCode | query | 是 | string | jsCode |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 |
GET
/api/member/get-mobilePhone
调用方法
GET /api/member/get-mobilePhone参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | query | 是 | string | appID | |
| code | query | 是 | string | code | |
| memberId | query | 否 | integer(int64) | memberId |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 |
GET
/api/member/feedback/query
调用方法
GET /api/member/feedback/query参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | query | 否 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberFeedback com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
GET
/api/member/feedback/page
调用方法
GET /api/member/feedback/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户Id | |
| companyId | query | 否 | integer(int64) | 公司Id | |
| memberId | query | 否 | string | 会员Id | |
| channel | query | 否 | string | 渠道 | |
| feedbackTypeEnum | query | 否 | string | 反馈类型 【 SURVEY : COMMENT : MESSAGE : GOODS_COMMENT : 】 | |
| originId | query | 否 | integer(int64) | 对应类型事物ID | |
| subject | query | 否 | string | 主题 | |
| comment | query | 否 | string | 留言 | |
| replys | query | 否 | string | 回复 | |
| status | query | 否 | string | 状态 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberFeedback com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
GET
/api/member/discount/page
调用方法
GET /api/member/discount/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| name | query | 否 | string | 名称 | |
| status | query | 否 | string | 状态 | "DRAFT" |
| buyRuleId | query | 否 | integer(int64) | 付费规则ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyDiscount com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
GET
/api/member/discount/get/{id}
调用方法
GET /api/member/discount/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberTypeBuyDiscount com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
GET
/api/member/contact/query/{id}
调用方法
GET /api/member/contact/query/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberContact com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact | 否 |
GET
/api/member/contact/list
调用方法
GET /api/member/contact/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| memberId | query | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberContact com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact[] | 否 | 返回数据 |
GET
/api/member/accountUpdateLog/page/{memberId}
调用方法
GET /api/member/accountUpdateLog/page/{memberId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| memberId | path | 是 | integer(int64) | 会员ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| accountTypeId | query | 是 | integer(int32) | 账户类型ID | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccountUpdateLog com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountUpdateLog | 否 |
GET
/api/member/account/type/list
调用方法
GET /api/member/account/type/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| code | query | 否 | string | 编号(只允许字母) | "BALANCE" |
| name | query | 否 | string | 名称 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccountType com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType[] | 否 | 返回数据 |
GET
/api/member/account/type/get/{id}
调用方法
GET /api/member/account/type/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccountType com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType | 否 |
GET
/api/member/account/list/{memberId}
调用方法
GET /api/member/account/list/{memberId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| memberId | path | 是 | integer(int64) | 会员ID | 0 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmMemberAccount com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccount[] | 否 | 返回数据 |
GET
/api/mallCustomer/getCertificationStatusByCustomerName/{merchantId}
调用方法
GET /api/mallCustomer/getCertificationStatusByCustomerName/{merchantId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| merchantId | path | 是 | integer(int64) | 商户ID | |
| customerName | query | 是 | string | 客户名称 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
GET
/api/mallAddress/queryPersonReceiveAddressList
调用方法
GET /api/mallAddress/queryPersonReceiveAddressList参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO[] | 否 | 返回数据 |
GET
/api/delivery-person/page
调用方法
GET /api/delivery-person/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| queryDTO | query | 是 | DeliveryPersonDTO$QueryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: DeliveryPersonListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryPersonListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryPersonListVO | 否 |
GET
/api/delivery-person/get/{id}
调用方法
GET /api/delivery-person/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 配送人员ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: DeliveryPersonDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.delivery.DeliveryPersonDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryPersonDetailVO | 否 |
GET
/api/delivery-carrier/page
调用方法
GET /api/delivery-carrier/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| queryDTO | query | 是 | DeliveryCarrierDTO$QueryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: DeliveryCarrierListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierListVO | 否 |
GET
/api/delivery-carrier/list
调用方法
GET /api/delivery-carrier/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| queryDTO | query | 是 | DeliveryCarrierDTO$QueryDTO |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: DeliveryCarrierListVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierListVO[] | 否 | 返回数据 |
GET
/api/delivery-carrier/get/{id}
调用方法
GET /api/delivery-carrier/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 载体ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: DeliveryCarrierDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierDetailVO | 否 |
GET
/api/customerContactPerson/page
调用方法
GET /api/customerContactPerson/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| phone | query | 否 | string | 电话 | |
| query | 否 | string | 邮箱 | ||
| mobile | query | 否 | string | 手机 | |
| customerId | query | 是 | integer(int64) | 客户ID | |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| originList | query | 否 | string[] |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CustomerContactPersonListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.customer.CustomerContactPersonListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CustomerContactPersonListVO | 否 |
GET
/api/customerContactPerson/list
调用方法
GET /api/customerContactPerson/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| phone | query | 否 | string | 电话 | |
| query | 否 | string | 邮箱 | ||
| mobile | query | 否 | string | 手机 | |
| customerId | query | 是 | integer(int64) | 客户ID | |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| originList | query | 否 | string[] |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerContactPerson com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson[] | 否 | 返回数据 |
GET
/api/customerContactPerson/get/{id}
调用方法
GET /api/customerContactPerson/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerContactPerson com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson | 否 |
GET
/api/customerCategory/list
调用方法
GET /api/customerCategory/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | query | 否 | string | 编号 | |
| name | query | 否 | string | 名称 | |
| statusList | query | 否 | string | 状态 | "ACTIVE" |
| parentId | query | 否 | integer(int64) | CRM对象ID | |
| idChain | query | 否 | string | 完整的组织结构 | |
| images | query | 否 | string | 图片地址 | |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| externalCode | query | 否 | string | 外部编号 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory[] | 否 | 返回数据 |
GET
/api/customerCategory/get/{id}
调用方法
GET /api/customerCategory/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomerCategory com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory | 否 |
GET
/api/customer/queryCustomerByCategoryId/{categoryId}
调用方法
GET /api/customer/queryCustomerByCategoryId/{categoryId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| categoryId | path | 是 | integer(int64) | 客户分类ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomer com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer[] | 否 | 返回数据 |
GET
/api/customer/page
调用方法
GET /api/customer/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | |
| companyId | query | 是 | integer(int64) | 公司ID | |
| code | query | 否 | string | 编号 | |
| type | query | 否 | string | 类型(公司/个人) 【 PERSONAL : COMPANY : 】 | |
| name | query | 否 | string | 名称 | |
| externalCode | query | 否 | string | 外部编号 | |
| statusList | query | 否 | string[] | ||
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 | |
| creditLevel | query | 否 | string | 信用等级 | |
| originList | query | 否 | string[] | ||
| certification | query | 否 | boolean | 是否认证 | |
| credit | query | 否 | boolean | 是否信用客户 | |
| certificationAuditStatus | query | 否 | string | 认证审核状态 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomer com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
GET
/api/customer/get/{id}
调用方法
GET /api/customer/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCustomer com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
GET
/api/crm/roleApplyRecord/reject/{id}
调用方法
GET /api/crm/roleApplyRecord/reject/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 申请ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
GET
/api/crm/roleApplyRecord/queryRecord
调用方法
GET /api/crm/roleApplyRecord/queryRecord参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| userName | query | 是 | string | 账号 | "xxx@xx.com" |
| password | query | 是 | string | 密码 | "MD5(pwd)" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmRoleApplyRecord com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmRoleApplyRecord | 否 |
GET
/api/crm/roleApplyRecord/queryRecord/{userId}
调用方法
GET /api/crm/roleApplyRecord/queryRecord/{userId}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| userId | path | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmRoleApplyRecord com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmRoleApplyRecord | 否 |
GET
/api/crm/roleApplyRecord/page
调用方法
GET /api/crm/roleApplyRecord/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| companyId | query | 是 | integer(int64) | 公司ID | 1 |
| type | query | 否 | string | 类型 | "AGENT" |
| applyType | query | 否 | string | 申请类型 【 REGISTER : UPDATE : YHD_SUPPLIER_LOCK : YHD_SUPPLIER_UNLOCK : YHD_SUPPLIER_DELETE : YHD_SUPPLIER_POTENTIAL_CONVERSION : YHD_SUPPLIER_POTENTIAL2_CONVERSION : YHD_SUPPLIER_TEMPORARY_CONVERSION : 】 | |
| userId | query | 否 | integer(int64) | 申请人 | |
| name | query | 否 | string | 名称 | |
| status | query | 否 | string | CRM角色申请状态 【 CONFIRM : REJECT : APPROVEING : DONE : CANCEL : 】 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RoleApplyRecordListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.RoleApplyRecordListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RoleApplyRecordListVO | 否 |
GET
/api/crm/roleApplyRecord/get/{id}
调用方法
GET /api/crm/roleApplyRecord/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 审核id | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: RoleApplyRecordDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.RoleApplyRecordDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RoleApplyRecordDetailVO | 否 |
GET
/api/carrier/page
调用方法
GET /api/carrier/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| status | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 | |
| supplierId | query | 否 | string | 供应商ID | 1 |
| internal | query | 否 | boolean | 内外部区分 | |
| categoryId | query | 否 | integer(int64) | 供应商分组Id |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCarrier com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCarrier | 否 |
GET
/api/carrier/get/{id}
调用方法
GET /api/carrier/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmCarrier com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCarrier | 否 |
GET
/api/agent/page
调用方法
GET /api/agent/page参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| type | query | 否 | string | 公司类型 | "PERSONAL" |
| name | query | 否 | string | 名称 | |
| code | query | 否 | string | 编号 | |
| externalCode | query | 否 | string | 外部编号 | |
| status | query | 否 | string | 状态 | "ACTIVE" |
| phone | query | 否 | string | 电话 | |
| mobile | query | 否 | string | 手机 | |
| internal | query | 否 | boolean | 内外部区分 | |
| categoryId | query | 否 | integer(int64) | 供应商分组Id |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmAgent com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmAgent
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmAgent | 否 |
GET
/api/agent/get/{id}
调用方法
GET /api/agent/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: CrmAgent com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmAgent
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmAgent | 否 |
GET
/api/address/queryCustomerReceiveAddressList
调用方法
GET /api/address/queryCustomerReceiveAddressList参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| customerId | query | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO[] | 否 | 返回数据 |
GET
/api/address/list
调用方法
GET /api/address/list参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| partnerId | query | 是 | integer(int64) | CRM关系ID | |
| status | query | 否 | string | 状态 【 ACTIVE : DEACTIVATE : DELETE : 】 | |
| type | query | 否 | string | 类型 | |
| def | query | 否 | boolean | 是否默认地址 | |
| origin | query | 否 | string | 来源 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO[] | 否 | 返回数据 |
GET
/api/address/get/{id}
调用方法
GET /api/address/get/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO | 否 |
DELETE
/api/supplierContactPerson/delete/{id}
调用方法
DELETE /api/supplierContactPerson/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/memberTypeUpgradeRule/delete/{id}
调用方法
DELETE /api/memberTypeUpgradeRule/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/memberTypeBuyRule/delete/{id}
调用方法
DELETE /api/memberTypeBuyRule/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/member/feedback/delete/{id}
调用方法
DELETE /api/member/feedback/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/member/discount/delete/{id}
调用方法
DELETE /api/member/discount/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/member/contact/del/{id}
调用方法
DELETE /api/member/contact/del/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/delivery-person/delete/{id}
调用方法
DELETE /api/delivery-person/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 配送人员ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/delivery-carrier/delete/{id}
调用方法
DELETE /api/delivery-carrier/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | 载体ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
DELETE
/api/customerContactPerson/delete/{id}
调用方法
DELETE /api/customerContactPerson/delete/{id}参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
模型定义
com.leadwaycloud.core.model.RJava.lang.Object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
供应评审模板
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| name | string | 否 | 名称 | |
| ruleId | integer(int64) | 是 | 商户ID | |
| version | string | 是 | 版本 | |
| content | string | 否 | 内容 | |
| active | boolean | 是 | 是否可用 | true |
| newVersion | boolean | 是 | 是否最新版本 | true |
| note | string | 否 | 备注 |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewTemplateDTO$UpdateDTO
编辑模板DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| ruleId | integer(int64) | 否 | 规则ID | 1 |
| name | string | 否 | 名称 | "1" |
| content | string | 否 | 内容 | "1" |
| active | boolean | 否 | 是否可用 |
com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewRuleDTO$UpdateDTO
编辑规则DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 编号 | "1" |
| frequency | string | 否 | 频率(月、季度、年) | "1" |
| supplierId | string | 否 | 供应商ID 多个用,分隔 | "1" |
| contractId | string | 否 | 合同ID 多个用,分隔 | "1" |
| contractAmount | string | 否 | 合同金额 | "1" |
| currencyId | integer(int64) | 否 | 货币符号ID | |
| exchangeRate | number(double) | 否 | 兑换本公司汇率 | |
| merge | boolean | 否 | 兑换本公司汇率 | |
| triggerDays | boolean | 否 | 频率触发日(1-31号) | |
| triggerMonth | boolean | 否 | 频率触发月(本月CURRENT_MONTH、次月FOLLOWING_MONTH) | |
| note | string | 否 | 备注 | "1" |
| active | boolean | 否 |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewDataDTO$UpdateDTO
编辑数据DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | "1" |
| note | string | 否 | 备注 | "1" |
| appendData | string | 否 | 附加参数 | "1" |
| status | string | 否 | 状态 | "1" |
| result | string | 否 | 结果 | "1" |
| purchaseData | string | 否 | 采购数据 |
com.leadwaycloud.crm.model.dto.CrmSupplierContactPersonDTO$UpdateDTO
编辑供应商联系人DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | 供应商联系人主键ID | |
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| mobile | string | 否 | 手机 | |
| type | string | 是 | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| typeOfWork | string | 否 | 工种:高空作业、电工等 | |
| age | string | 否 | 年龄 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| attachmentsRequired | string | 否 | 必要附件 | |
| idCard | string | 否 | 身份证 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
供应商联系人
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| supplierId | integer(int64) | 是 | 供应商ID | |
| merchantId | integer(int64) | 是 | 商户ID | |
| mobile | string | 否 | 手机 | |
| type | string | 是 | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| typeOfWork | string | 否 | 工种:高空作业、电工等 | |
| age | integer(int32) | 否 | 年龄 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| attachmentsRequired | string | 否 | 必要附件 | |
| status | string | 是 | 状态 | |
| idCard | string | 否 | 身份证 | |
| partnerId | integer(int64) | 否 | CRM客户关系 |
com.leadwaycloud.crm.model.dto.SupplierCategoryDTO$UpdateDTO
改变供应商分组信息模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | |
| name | string | 否 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
供应商种类
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 是 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 是 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 是 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.dto.PartnerSupplierCategoryDTO$AddDTO
供应商分组和角色进行绑定模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| supplierCategoryIdList | integer(int64)[] | 否 | 供应商分组Id集合 | |
| partnerIdList | integer(int64)[] | 否 | partner角色Id集合 |
com.leadwaycloud.crm.model.dto.ContactDTO$UpdateDTO
编辑角色联系地址信息DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | id | |
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 否 | 详细地址 | |
| postcode | string | 否 | 邮编 | |
| phone | string | 否 | 电话 | |
| mobile | string | 否 | 手机 | |
| phoneExtension | string | 否 | 电话-分机号 | |
| fax | string | 否 | 传真 | |
| faxExtension | string | 否 | 传真-分机号 | |
| string | 否 | 邮箱 | ||
| langId | integer(int64) | 否 | 语言 | |
| houseNumber | string | 否 | 门牌号 |
com.leadwaycloud.crm.model.dto.CrmSupplierContactPersonDTO$AddDTO
添加供应商联系人DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| mobile | string | 否 | 手机 | |
| type | string | 是 | 类型:CONTACT=联系人;PROJECT_SUPERVISOR=项目负责人;SAFETY_SUPERVISOR=安全负责人;WORKER=普通人员 | |
| typeOfWork | string | 否 | 工种:高空作业、电工等 | |
| age | integer(int32) | 否 | 年龄 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| attachmentsRequired | string | 否 | 必要附件 | |
| idCard | string | 否 | 身份证 |
com.leadwaycloud.crm.model.dto.CrmSupplierDTO$UpdateDTO
编辑供应商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | 供应商ID | |
| name | string | 否 | 名称 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "个人" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| shortName | string | 否 | 简称 | |
| source | string | 否 | 来源 | |
| sourceInfo | string | 否 | 来源补充信息 | |
| settlementMethod | string | 否 | 结算类型 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| code | string | 否 | 编号 | |
| distributionMode | string | 否 | 经销模式 | |
| enterpriseType | string | 否 | 企业类型 | |
| operatingStatus | string | 否 | 经营状态 | |
| abnormalStatusReason | string | 否 | 经营状态异常说明 | |
| version | string | 否 | 版本号 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredAddress | string | 否 | 注册地址 | |
| extensionInfo | string | 否 | 供应商额外属性 | |
| cooperationStatus | string | 否 | 供应商合作状态 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| contact | ContactDTO$UpdateDTO | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| financePaymentBankList | FinancePaymentBankDTO$UpdateDTO[] | 否 | 付款信息集合 | |
| epo | boolean | 否 | 是否开启E订单 | |
| restrictType | string | 否 | 采购限制类型 | |
| restrictQty | number(double) | 否 | 采购限制数量 | |
| orderExpiredClose | boolean | 否 | 是否开启订单过期关闭 | |
| orderValidity | integer(int32) | 否 | 订单有效期 | |
| supplierCategoryIdList | integer(int64) | 否 | 供应商分组Id集合 | |
| supplierContactPersonList | CrmSupplierContactPersonDTO$AddDTO | 否 |
com.leadwaycloud.crm.model.dto.FinanceInvoiceTitleDTO$UpdateDTO
编辑发票抬头DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 是 | ID | |
| headerName | string | 否 | 抬头名称 | |
| address | string | 否 | 地址 | |
| taxNo | string | 否 | 税号 | |
| phone | string | 否 | 电话 | |
| bank | string | 否 | 开户银行 | |
| bankAccounts | string | 否 | 银行账户 | |
| recipient | string | 否 | 收件人 | |
| mailAddress | string | 否 | 邮寄地址 | |
| receivePhone | string | 否 | 收件人手机或电话 | |
| billingPeriod | integer(int32) | 否 | 账期 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| def | boolean | 否 | 是否默认 | |
| status | string | 否 | 状态 | |
| externalCode | string | 否 | 外部编号 | |
| invoiceType | string | 否 | 发票类型 |
com.leadwaycloud.crm.model.dto.FinancePaymentBankDTO$UpdateDTO
编辑付款信息详情DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 是 | ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | 1 |
| countryId | integer(int64) | 否 | 国家 | 1 |
| cityId | integer(int64) | 否 | 城市ID | 1 |
| areaId | integer(int64) | 否 | 区、县ID | 1 |
| streetId | integer(int64) | 否 | 街道ID | 1 |
| streets | string | 否 | 其他街道详情 | |
| name | string | 否 | 开户行名称 | |
| bankCode | string | 否 | 银行代码 | |
| bankAccount | string | 否 | 账户名/账户持有人名称 | |
| accountNumber | string | 否 | 银行账户/账户持有人账号 | |
| ibanCode | string | 否 | IBAN编码 | |
| swiftCode | string | 否 | IBAN编码 | |
| abaRouting | string | 否 | ABA美航账户号 | |
| intermediaryBank | string | 否 | 中间银行 | |
| billingPeriod | integer(int64) | 否 | 付款账期 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| cnapsCode | string | 否 | 联行号 | |
| def | boolean | 否 | 是否默认 | |
| status | string | 否 | 状态 | |
| reference | string | 否 | 参考明细 | |
| invoiceMethod | string | 否 | 开票方式 | |
| tax | string | 否 | 税率 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
com.leadwaycloud.crm.model.bo.FullAddressBO
五级联动地址BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| country | FullAddressBO$CountryBO | 否 | ||
| province | FullAddressBO$ProvinceBO | 否 | ||
| city | FullAddressBO$CityBO | 否 | ||
| area | FullAddressBO$AreaBO | 否 | ||
| street | FullAddressBO$StreetBO | 否 |
com.leadwaycloud.crm.model.bo.FullAddressBO$AreaBO
区BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 |
com.leadwaycloud.crm.model.bo.FullAddressBO$CityBO
市BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 |
com.leadwaycloud.crm.model.bo.FullAddressBO$CountryBO
国家BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 国际代号 |
com.leadwaycloud.crm.model.bo.FullAddressBO$ProvinceBO
省BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 |
com.leadwaycloud.crm.model.bo.FullAddressBO$StreetBO
街道BO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | string | 否 | ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplier
供应商
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| partnerId | integer(int64) | 是 | CRM对象ID | |
| externalCode | string | 否 | 外部编号 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| status | string | 是 | 状态 | |
| currencyId | integer(int64) | 否 | 货币 | |
| type | string | 是 | 公司类型 | |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| contactId | integer(int64) | 否 | 地址 | |
| settlementMethod | string | 否 | 供应商结算类型(默认结算类型)-爱达，维护供应商与公司绑定关系可重新设置结算类型 | |
| origin | string | 否 | 来源 | |
| eligible | boolean | 否 | 是否合格供应商-万航 | |
| shortName | string | 否 | 简称 | |
| source | string | 否 | 来源 | |
| sourceInfo | string | 否 | 来源补充信息 | |
| distributionMode | string | 否 | 经销模式 | |
| enterpriseType | string | 否 | 企业类型 | |
| operatingStatus | string | 否 | 经营状态 | |
| abnormalStatusReason | string | 否 | 经营状态异常说明 | |
| version | string | 否 | 版本号 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredAddress | string | 否 | 注册地址 | |
| extensionInfo | string | 否 | 供应商额外属性 | |
| cooperationStatus | string | 否 | 供应商合作状态 | |
| epo | boolean | 否 | 是否开启E订单 | |
| restrictType | string | 否 | 采购限制类型 | |
| restrictQty | number(double) | 否 | 采购限制数量 | |
| orderExpiredClose | boolean | 否 | 是否开启订单过期关闭 | |
| orderValidity | integer(int32) | 否 | 订单有效期 | |
| contact | ResContact | 否 | ||
| currency | SysCurrency | 否 | ||
| partner | ResPartner | 否 | ||
| supplierCategoryList | CrmSupplierCategory[] | 否 | 分类集合 | |
| financeInvoiceTitle | FinanceInvoiceTitle | 否 | ||
| financePaymentBankList | FinancePaymentBank[] | 否 | 付款信息集合 | |
| supplierCompanyRelation | CrmSupplierCompanyRelation | 否 | ||
| supplierContactPersonList | CrmSupplierContactPerson | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierCompanyRelation
供应商公司关联关系
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| companyId | integer(int64) | 是 | 公司Id | |
| supplierId | integer(int64) | 是 | 供应商Id | |
| status | string | 是 | 状态 | |
| settlementMethod | string | 否 | 供应商结算类型-爱达 | |
| supplier | CrmSupplier | 否 | ||
| company | ResCompany | 否 |
com.leadwaycloud.crm.model.entity.finance.FinanceInvoiceTitle
发票抬头
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| headerName | string | 否 | 抬头名称 | |
| address | string | 否 | 地址 | |
| taxNo | string | 否 | 税号 | |
| phone | string | 否 | 电话 | |
| bank | string | 否 | 开户银行 | |
| bankAccounts | string | 否 | 银行账户 | |
| invoiceType | string | 否 | 发票类型 | |
| recipient | string | 否 | 收件人 | |
| mailAddress | string | 否 | 邮寄地址 | |
| receivePhone | string | 否 | 收件人手机或电话 | |
| partnerId | integer(int64) | 是 | CRM客户关系 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| billingPeriod | integer(int32) | 否 | 账期 | |
| status | string | 否 | 状态 | |
| def | boolean | 否 | 是否默认 | |
| externalCode | string | 否 | 外部编号 |
com.leadwaycloud.crm.model.entity.finance.FinancePaymentBank
付款信息
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| countryId | integer(int64) | 否 | 国家 | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| streets | string | 否 | 其他街道详情 | |
| name | string | 否 | 开户行名称 | |
| bankCode | string | 否 | 银行代码 | |
| bankAccount | string | 否 | 账户名/账户持有人名称 | |
| accountNumber | string | 否 | 银行账户/账户持有人账号 | |
| ibanCode | string | 否 | 国际银行账户号码，是一种全球通用的标准化银行账户识别编码，主要用于跨境支付清算，确保国际转账的准确性和效率。 | |
| swiftCode | string | 否 | 国际银行间跨境汇款通用代码（如美元/欧元），由8-11位字母数字混合组成，由环球同业银行金融电讯协会管理 | |
| abaRouting | string | 否 | ABA美航账户号 | |
| intermediaryBank | string | 否 | 银行类别 | |
| billingPeriod | integer(int64) | 否 | 付款账期 | |
| partnerId | integer(int64) | 是 | 关联PARTNER ID | |
| merchantId | integer(int64) | 是 | 商户ID | |
| cnapsCode | string | 否 | 用于中国境内银行间清算，由12位数字组成，覆盖人民币业务 | |
| status | string | 否 | 状态 | |
| def | boolean | 否 | 是否默认 | |
| reference | string | 否 | 参考明细 | |
| invoiceMethod | string | 否 | 开票方式 | |
| tax | string | 否 | 税率 | |
| paymentBankAddress | FullAddressBO | 否 |
com.leadwaycloud.crm.model.entity.res.ResCompany
公司
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| partnerId | integer(int64) | 是 | 关系ID | |
| code | string | 是 | 公司编号（仅允许字母和数字） | "CD01" |
| otherCode | string | 否 | 其他编号 | "AAAA-01" |
| type | string | 是 | 类型 | |
| status | string | 是 | 状态 | |
| parentId | integer(int64) | 否 | 上级公司ID | |
| idChain | string | 否 | 公司ID完整架构（上下级公司id用-连接） | "123-456" |
| slogan | string | 否 | 公司标语 | |
| initConfig | boolean | 否 | 是否已经初始化公司配置 true:已初始化 false:未初始化 | false |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
| contactId | integer(int64) | 否 | 地址ID | |
| foreignNames | string | 否 | 其他国家名称JSON字符串 | |
| content | string | 否 | 其他详情JSON字符串，可动态添加附件字段名 | |
| enName | string | 否 | 发票名称 | |
| currencyId | integer(int64) | 否 | 货币Id |
com.leadwaycloud.crm.model.entity.res.ResContact
地址联系关系
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 否 | 详细地址 | |
| postcode | string | 否 | 邮编 | |
| phone | string | 否 | 电话 | |
| phoneExtension | string | 否 | 电话-分机号 | |
| mobile | string | 否 | 手机 | |
| fax | string | 否 | 传真 | |
| faxExtension | string | 否 | 传真-分机号 | |
| string | 否 | 邮箱 | "邮箱" | |
| houseNumber | string | 否 | 门牌号 | |
| contactAddress | FullAddressBO | 否 |
com.leadwaycloud.crm.model.entity.res.ResPartner
CRM关系
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| member | boolean | 否 | 会员 | false |
| supplier | boolean | 否 | 供应商 | false |
| customer | boolean | 否 | 客户 | false |
| employee | boolean | 否 | 员工 | false |
| franchisee | boolean | 否 | 加盟商 | false |
| company | boolean | 否 | 公司 | false |
| user | boolean | 否 | 用户 | false |
| carrier | boolean | 否 | 承运商 | false |
| agent | boolean | 否 | 代理 | false |
| producer | boolean | 否 | 生产商 | false |
| extensionInfo | string | 否 | 扩展数据,设置客户资质信息(资质文件/签名/印章)等 | |
| customerPerson | boolean | 否 | 客户联系人 | false |
com.leadwaycloud.crm.model.entity.sys.SysCurrency
货币模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | "CNY" |
| name | string | 是 | 名称 | "人民币" |
| symbol | string | 是 | 符号 | "¥" |
| active | boolean | 是 | 是否可用 | true |
| calcRate | boolean | 是 | 是否计算汇率 | true |
| image | string | 否 | 图片 | |
| rounding | integer(int32) | 是 | 四舍五入精度 | |
| calcRateUnit | number(double) | 否 | 汇率计算单位 | |
| roundingType | string | 否 | 金额进舍规则:0=全部进位,1=全部舍位,2=四舍五入 | "2" |
com.leadwaycloud.crm.model.dto.SupplierOutletsDTO$UpdateDTO
编辑供应商网点DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | "银泰城永辉超市" |
| code | string | 是 | 标识 | "...." |
| type | string | 是 | 类型 | "SELF_PICKUP_OUTLETS" |
| contactPerson | string | 是 | 联络人 | "张三" |
| phone | string | 是 | 电话 | "13888888888" |
| address | string | 否 | 地址 | "银泰城负一楼永辉超市" |
| status | string | 是 | 状态 | "ACTIVE" |
| latLon | string | 是 | 经纬度（纬度,经度） | "104.064737,30.547256" |
| openingTime | LocalTime | 否 | ||
| closingTime | LocalTime | 否 | ||
| image | string | 否 | 图片 |
java.time.LocalTime
关店时间
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| hour | integer(int32) | 否 | ||
| minute | integer(int32) | 否 | ||
| second | integer(int32) | 否 | ||
| nano | integer(int32) | 否 |
com.leadwaycloud.crm.model.dto.CrmProducerDTO$UpdateDTO
编辑生产商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| status | string | 是 | 状态 | |
| dependency | string | 否 | 属地 | |
| updateContractDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmProducer
生产商
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| partnerId | integer(int64) | 是 | CRM对象ID | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | |
| companyId | integer(int64) | 是 | 公司ID | |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| contactId | integer(int64) | 是 | 地址 | |
| status | string | 是 | 状态 | |
| dependency | string | 否 | 属地 | |
| contact | ResContact | 否 | ||
| partner | ResPartner | 否 | ||
| currency | SysCurrency | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitle | 否 | ||
| financePaymentBank | FinancePaymentBank | 否 |
com.leadwaycloud.crm.model.dto.MemberTypeUpgradeRuleDTO$UpdateDTO
编辑会员晋级规则模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| online | boolean | 否 | 是否上线 | true |
| upgradeRuleDetailDTOList | MemberTypeUpgradeRuleDetailDTO[] | 否 | 规则 |
com.leadwaycloud.crm.model.dto.MemberTypeUpgradeRuleDetailDTO
添加会员晋级规则详情模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | 1 |
| level | integer(int32) | 是 | 晋级等级 | |
| typeId | integer(int64) | 是 | 会员类型ID | 1 |
| checkFrequencyType | string | 是 | 检查频率类型（com.leadwaycloud.common.enums.databaseEnum.CheckFrequencyTypeEnum） | "DAY" |
| keepTypeForTypeId | integer(int64) | 否 | 保持会员类型所需要的值类型 | 1 |
| keepTypeForTypeValue | number(double) | 否 | 保持会员类型所需要类型对应的值 | |
| keepTypeForConsumptionValue | number(double) | 否 | 保持会员类型所需要消费金额 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
会员账户类型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| code | string | 是 | 编号(只允许字母,且商户下唯一) | "abc" |
| name | string | 是 | 名称 | |
| changeValue | number(double) | 否 | 兑换值 多少兑换值可换1元现金 | 3 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberType
会员类型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| name | string | 是 | 名称 | |
| code | string | 是 | 编号 | |
| description | string | 否 | 描述 | |
| system | boolean | 是 | 是否是系统创建角色 | true |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
会员类型晋级规则
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 所属商户ID | |
| name | string | 是 | 名称 | |
| online | boolean | 是 | 是否上线 | true |
| upgradeRuleDetailList | CrmMemberTypeUpgradeRuleDetail[] | 否 | 规则 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRuleDetail
会员类型晋级策略
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| upgradeRuleId | integer(int64) | 是 | 晋级规则ID | |
| level | integer(int32) | 是 | 晋级等级 | |
| typeId | integer(int64) | 是 | 会员类型ID | |
| checkFrequencyType | string | 是 | 检查频率类型 | |
| keepTypeForTypeValue | number(double) | 否 | 保持会员类型所需要类型对应的值 | |
| keepTypeForConsumptionValue | number(double) | 否 | 保持会员类型所需要消费金额 | |
| higherDetailId | integer(int64) | 否 | 上一级的晋级策略 | |
| lowerDetailId | integer(int64) | 否 | 下一级的晋级策略 | |
| keepTypeForTypeId | integer(int64) | 否 | 保持会员类型所需要的值类型ID | |
| memberType | CrmMemberType | 否 | ||
| keepTypeForType | CrmMemberAccountType | 否 |
com.leadwaycloud.crm.model.dto.MemberBuyRuleTenderDTO
编辑付费会员支付规则模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | 1 |
| tenderId | integer(int64) | 是 | 支付方式ID | 1 |
| costValue | number(double) | 是 | 购买的成本 |
com.leadwaycloud.crm.model.dto.MemberTypeBuyRuleDTO$UpdateDTO
编辑付费晋级规则模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 购买活动名称 | |
| currentMemberTypeId | integer(int64) | 否 | 当前的会员类型ID | 1 |
| buyMemberTypeId | integer(int64) | 否 | 购买的会员类型 | 1 |
| validDay | integer(int32) | 否 | 有效日(在会员成为该类型多少天后，需还原为变更前的类型。未设置则表示永久) | |
| startDate | string(date) | 是 | 开始日期 | |
| endDate | string(date) | 是 | 结束时间 | |
| online | boolean | 是 | 是否上线 | true |
| memberTypeBuyRuleGiftDTOList | MemberTypeBuyRuleGiftDTO[] | 否 | 赠送详情 | |
| memberBuyRuleTenderDTOList | MemberBuyRuleTenderDTO[] | 否 | 支付规则 |
com.leadwaycloud.crm.model.dto.MemberTypeBuyRuleGiftDTO
编辑付费晋级赠送模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | 1 |
| accountTypeId | integer(int64) | 是 | 赠送价值类型(会员账户类型) | |
| giftValue | number(double) | 是 | 赠送价值 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberBuyRuleTender
付费会员支付规则
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| tenderId | integer(int64) | 是 | 支付方式ID | |
| costValue | number(double) | 是 | 购买的成本 | |
| buyRuleId | integer(int64) | 是 | 购买规则 | |
| tender | RmTender | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
会员类型购买规则
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 所属商户ID | |
| name | string | 是 | 购买活动名称 | |
| currentTypeId | integer(int64) | 是 | 当前的会员类型ID | |
| buyTypeId | integer(int64) | 是 | 购买的会员类型ID | |
| validDay | integer(int32) | 否 | 有效日(在会员成为该类型多少天后，需还原为变更前的类型。未设置则表示永久) | |
| online | boolean | 是 | 是否上线 | true |
| startDate | string(date) | 是 | 开始日期 | |
| endDate | string(date) | 是 | 结束时间 | |
| currentMemberType | CrmMemberType | 否 | ||
| buyMemberType | CrmMemberType | 否 | ||
| memberTypeBuyRuleGiftList | CrmMemberTypeBuyRuleGift[] | 否 | 赠送详情 | |
| memberBuyRuleTenderList | CrmMemberBuyRuleTender[] | 否 | 支付规则 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRuleGift
付费晋级赠送模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| buyRuleId | integer(int64) | 是 | 购买规则 | |
| accountTypeId | integer(int64) | 是 | 赠送价值类型(会员账户类型) | |
| giftValue | number(double) | 是 | 赠送价值 | |
| accountType | integer(int64) | 否 | 赠送价值类型(会员账户类型) |
com.leadwaycloud.crm.model.entity.rm.RmTender
支付方式
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| code | string | 是 | 代号 | "CASH" |
| name | string | 是 | 名称 | "现金" |
| otherName | string | 否 | 别名 | "钞票" |
| type | string | 是 | 类型 | "CASH" |
| status | string | 是 | 状态 | "AVAILABLE" |
| image | string | 否 | 图片 | |
| vat | boolean | 否 | 是否可开发票 | true |
| memberAccountTypeId | integer(int64) | 否 | 账户类型 | |
| mobilePaymentType | string | 否 | 移动支付类型 | "WECHAT" |
| system | boolean | 否 | 是否由系统默认 | true |
| description | string | 否 | 描述 | |
| financeTenderId | integer(int64) | 是 | 财务付款方式ID | |
| otherCode | string | 否 | 其他编号 |
com.leadwaycloud.crm.model.dto.MemberTypeDTO$UpdateDTO
编辑会员类型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| system | boolean | 否 | 系统默认 | |
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
com.leadwaycloud.crm.model.dto.MemberTypeChangeDTO
会员类型变更模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| typeId | integer(int64) | 是 | 会员类型ID | 1 |
| remark | string | 是 | 备注 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmAddress
地址管理
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| partnerId | integer(int64) | 是 | CRM关系ID | |
| name | string | 否 | 名称 | |
| countryId | integer(int64) | 是 | 国家ID | |
| stateId | integer(int64) | 是 | 省、直辖市ID | |
| cityId | integer(int64) | 是 | 城市ID | |
| areaId | integer(int64) | 是 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| receiver | string | 是 | 收件人 | |
| def | boolean | 否 | 是否默认地址 | |
| status | string | 否 | 状态 | |
| type | string | 否 | 类型 | |
| externalCode | string | 否 | 外部编号 | |
| origin | string | 否 | 来源 | |
| contactAddress | FullAddressBO | 否 | ||
| createUser | ResUser | 否 | ||
| completeAddress | string | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmCustomer
客户
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| partnerId | integer(int64) | 是 | CRM对象ID | |
| externalCode | string | 否 | 外部编号 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| status | string | 是 | 状态 | |
| currencyId | integer(int64) | 是 | 货币 | |
| type | string | 是 | 公司类型 | |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 是 | 公司ID | |
| contactId | integer(int64) | 否 | 地址 | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| origin | string | 否 | 来源 | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| extensionInfo | string | 否 | 额外属性 | |
| certificationAuditStatus | string | 否 | 认证审核状态 | |
| partner | ResPartner | 否 | ||
| currency | SysCurrency | 否 | ||
| contact | ResContact | 否 | ||
| customerCategoryList | CrmCustomerCategory[] | 否 | 客户分类集合 | |
| financeInvoiceTitleList | FinanceInvoiceTitle[] | 否 | 发票抬头集合 | |
| customerContactPersonList | CrmCustomerContactPerson[] | 否 | 客户联系人集合 | |
| addressList | CrmAddress[] | 否 | 收货地址集合 |
com.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
客户分类
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 是 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 是 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 是 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
客户联系人
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| customerId | integer(int64) | 是 | 客户Id | |
| merchantId | integer(int64) | 是 | 商户Id | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| partnerId | integer(int64) | 否 | CRM关系Id | |
| status | string | 否 | 状态 | |
| code | string | 否 | 编号 | |
| origin | string | 否 | 来源 | |
| externalCode | string | 否 | 外部编号 | |
| user | ResUser | 否 | ||
| member | CrmMember | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMember
会员
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| companyId | integer(int64) | 否 | 公司ID | |
| barcode | string | 是 | 会员号 | |
| otherBarcode | string | 否 | 第三方条码 | |
| status | string | 是 | 状态 | |
| name | string | 是 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 是 | 性别 | |
| birthYear | integer(int32) | 否 | 出生年份 | |
| birthday | string | 否 | 出生日期 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机 | |
| source | string | 是 | 会员来源 | |
| typeExpiryDate | string(date) | 否 | 类型到期日 | |
| partnerId | integer(int64) | 是 | 关系ID | |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| typeId | integer(int64) | 是 | 类型ID | |
| beforeTypeId | integer(int64) | 否 | 变更前会员类型ID | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| familyRef | boolean | 是 | 是否家庭主成员主账户 | |
| customerId | integer(int64) | 否 | 客户ID | |
| origin | string | 否 | 来源 | |
| partner | ResPartner | 否 | ||
| beforeType | CrmMemberType | 否 | ||
| memberType | CrmMemberType | 否 | ||
| customer | CrmCustomer | 否 | ||
| memberAccountList | CrmMemberAccount[] | 否 | 会员账户信息 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
会员账户
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| memberId | integer(int64) | 是 | 会员Id | |
| typeId | integer(int64) | 是 | 账户类型Id | |
| status | string | 是 | 状态 | |
| value | number(double) | 是 | 账户价值 | |
| system | boolean | 是 | 是否是系统默认的 | |
| accountType | CrmMemberAccountType | 否 | ||
| cashValue | number(double) | 否 | 账户现金价值 |
com.leadwaycloud.crm.model.entity.res.ResUser
用户模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| status | string | 是 | 状态 | |
| userName | string | 是 | 登录名称 | |
| language | string | 是 | 语言 | "zh_CN" |
| companyId | integer(int64) | 否 | 公司ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| readVersionInfo | boolean | 否 | 是否已读更新版本信息 | false |
| name | string | 否 | 名称 | |
| image | string | 否 | 图片 | |
| partnerId | integer(int64) | 是 | CRM对象ID | |
| contactId | integer(int64) | 否 | 地址联系ID | |
| sign | string | 否 | 用户签名 | |
| forceUpdatePassword | boolean | 否 | 是否强制修改密码 | |
| idaasId | string | 否 | idaas唯一ID | |
| allowLoginChannel | string | 否 | 允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开 | |
| registerChannel | string | 否 | 注册渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS) | |
| userAuditStatus | string | 否 | 用户审核状态 | |
| externalCode | string | 否 | 外部编号 |
com.leadwaycloud.crm.model.dto.MemberDTO$UpdateDTO
编辑会员模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| otherBarcode | string | 否 | 第三方条码 | |
| status | string | 否 | 状态 | "1" |
| name | string | 否 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 否 | 性别 | "男" |
| appId | string | 否 | appId | |
| birthday | string(date) | 否 | 生日 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机 | |
| image | string | 否 | 图片 | |
| openId | string | 否 | openId | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| customerId | integer(int64) | 否 | 客户ID |
com.leadwaycloud.crm.model.dto.UpdateMemberBindDTO
修改会员绑定状态DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| openId | string | 是 | openId | |
| status | string | 是 | 绑定状态（BOUND:绑定、UNBIND：解绑） |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberOpenRef
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberOpenRef | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberOpenRef
会员绑定信息模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| openId | string | 是 | 微信openID | |
| appId | string | 是 | 应用ID | |
| status | string | 是 | 状态 | |
| memberId | integer(int64) | 是 | 会员 | |
| bindingInfo | string | 否 | 第三方连接系统会员绑定信息,比如PMS系统游客的必要信息 |
com.leadwaycloud.crm.model.dto.MemberBindDTO
会员绑定模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| name | string | 是 | 名称 | |
| redisKey | string | 是 | redisKey | |
| openId | string | 是 | openId | |
| verifyCode | string | 是 | 验证码 | |
| appId | string | 是 | appId | |
| sex | string | 是 | 性别（com.leadwaycloud.common.enums.databaseEnum.SexEnum） | "0" |
| mobilePhone | string | 是 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源（com.leadwaycloud.common.enums.databaseEnum.SourceCodeEnum） | "ERP" |
| autoRegister | boolean | 是 | 自主注册 |
com.leadwaycloud.crm.model.dto.MemberFeedBackDTO$UpdateDTO
编辑留言
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户Id | |
| companyId | integer(int64) | 是 | 公司Id | |
| memberId | string | 是 | 会员Id | |
| channel | string | 否 | 渠道 | |
| feedbackTypeEnum | string | 是 | 反馈类型 | |
| originId | integer(int64) | 否 | 对应类型事物ID | |
| subject | string | 否 | 主题 | |
| comment | string | 否 | 留言 | |
| replys | string | 否 | 回复 | |
| status | string | 是 | 状态 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
留言管理
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户Id | |
| companyId | integer(int64) | 是 | 公司Id | |
| memberId | string | 是 | 会员Id | |
| channel | string | 否 | 渠道 | |
| feedbackTypeEnum | string | 是 | 反馈类型 | |
| originId | integer(int64) | 否 | 对应类型事物ID | |
| subject | string | 否 | 主题 | |
| comment | string | 否 | 留言 | |
| replys | string | 否 | 回复 | |
| status | string | 是 | 状态 | |
| batchId | string | 否 | 批次、旅游航线 | |
| memberName | string | 否 | 会员名称 | |
| location | string | 否 | 位置 | |
| version | integer(int32) | 否 | 版本 | |
| images | string | 否 | 图片 |
com.leadwaycloud.crm.model.dto.MemberTypeBuyDiscountDTO$UpdateDTO
编辑折扣模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| discValue | number(double) | 是 | 折扣值 | |
| status | string | 是 | 状态 | "DRAFT" |
| channel | string | 是 | 促销渠道 | |
| startTime | string(date) | 是 | 开始时间 | |
| endTime | string(date) | 是 | 结束时间 | |
| buyRuleId | integer(int64) | 是 | 付费规则ID | 1 |
| description | string | 否 | 描述 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
付费会员折扣
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| name | string | 是 | 名称 | |
| discValue | number(double) | 是 | 折扣值 | |
| status | string | 是 | 状态 | |
| channel | string | 是 | 促销渠道 | |
| startTime | string(date) | 是 | 开始时间 | |
| endTime | string(date) | 是 | 结束时间 | |
| buyRuleId | integer(int64) | 是 | 付费规则ID | |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.dto.MemberContactDTO$UpdateDTO
编辑会员地址模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| countryId | integer(int64) | 否 | 国家ID | 1 |
| provinceId | integer(int64) | 否 | 省、直辖市 | 1 |
| cityId | integer(int64) | 否 | 城市 | 1 |
| areaId | integer(int64) | 否 | 区、县 | 1 |
| streetId | integer(int64) | 否 | 街道 | 1 |
| address | string | 否 | 详细地址 | |
| mobile | string | 否 | 手机 | |
| name | string | 否 | 名称 | |
| def | boolean | 否 | 默认 | false |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberContact
会员地址模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| memberId | integer(int64) | 是 | 会员ID | |
| countryId | integer(int64) | 是 | 国家ID | |
| stateId | integer(int64) | 是 | 省、直辖市ID | |
| cityId | integer(int64) | 是 | 城市Id | |
| areaId | integer(int64) | 是 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| name | string | 是 | 名称 | |
| def | boolean | 是 | 默认 | false |
| country | SysCountry | 否 | ||
| province | SysProvince | 否 | ||
| city | SysCity | 否 | ||
| area | SysArea | 否 | ||
| street | SysStreet | 否 |
com.leadwaycloud.crm.model.entity.sys.SysArea
区、县
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 是 | code | |
| customize | boolean | 是 | 是否定制 | |
| cityId | integer(int64) | 是 | cityID |
com.leadwaycloud.crm.model.entity.sys.SysCity
城市
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 是 | code | |
| customize | boolean | 是 | 是否定制 | |
| provinceId | integer(int64) | 是 | provinceID |
com.leadwaycloud.crm.model.entity.sys.SysCountry
国家
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 是 | 国际代号 | |
| language | string | 是 | 语言国际编码 | |
| timezone | string | 是 | 时区 | |
| phoneCode | string | 否 | 国际代号 |
com.leadwaycloud.crm.model.entity.sys.SysProvince
省份
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 是 | code | |
| customize | boolean | 是 | ||
| countryId | integer(int64) | 是 |
com.leadwaycloud.crm.model.entity.sys.SysStreet
街道
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| name | string | 是 | 名称 | |
| code | string | 是 | code | |
| customize | boolean | 是 | ||
| areaId | integer(int64) | 是 |
com.leadwaycloud.crm.model.dto.MemberAccountDTO
变更会员账户模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| memberId | integer(int64) | 否 | 会员ID | 1 |
| memberBarcode | string | 否 | 会员编号 | "002391117577753472" |
| accountTypeId | integer(int64) | 是 | 账户类型ID | 1 |
| type | string | 是 | 会员账户权益变更类型（com.leadwaycloud.common.enums.databaseEnum.MemberAccountUpdateEnum） | "INCREASE" |
| changeValue | number(double) | 否 | 变更值 | |
| remark | string | 否 | 备注 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccount | 否 |
com.leadwaycloud.crm.model.dto.MemberAccountTypeDTO$UpdateDTO
编辑账户类型DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号(只允许字母) | "BALANCE" |
| name | string | 是 | 名称 | |
| changeValue | number(double) | 否 | 兑换值 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType | 否 |
com.leadwaycloud.crm.model.dto.DeliveryPersonDTO$UpdateDTO
编辑配送人员DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | string | 否 | 类型 | |
| name | string | 否 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司 | |
| externalCode | string | 否 | 外部编码 | |
| note | string | 否 | 备注 |
com.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$UpdateDTO
编辑配送载体DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| identifier | string | 否 | 车牌号 | |
| note | string | 否 | 备注 |
com.leadwaycloud.crm.model.dto.CustomerContactPersonDTO$UpdateDTO
编辑联系地址DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| status | string | 否 | 状态 | |
| code | string | 否 | 编号 | |
| externalCode | string | 否 | 外部编号 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson | 否 |
com.leadwaycloud.crm.model.dto.CrmCustomerCategoryDTO$UpdateDTO
修改客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 编号 | |
| name | string | 否 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory | 否 |
com.leadwaycloud.crm.model.dto.CrmCustomerCategoryDTO$AddPartnerCustomerCategoryDTO
客户分组和角色进行绑定模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| customerCategoryIdList | integer(int64)[] | 否 | 客户分组Id集合 | |
| partnerIdList | integer(int64)[] | 否 | partner角色Id集合 |
com.leadwaycloud.crm.model.dto.CrmCustomerDTO$UpdateDTO
修改客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 类型(公司/个人) | |
| status | string | 否 | 状态 | |
| image | string | 否 | 图片 | |
| contact | ContactDTO$UpdateDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$UpdateDTO[] | 否 | 发票抬头 | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| extensionInfo | string | 否 | 额外属性 | |
| certificationAuditStatus | string | 否 | 认证审核状态 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
com.leadwaycloud.crm.model.dto.RoleApplyRecordDTO$UpdateDTO
修改CRM角色申请DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| recordId | integer(int64) | 是 | 申请记录ID | 1 |
| userId | integer(int64) | 是 | 用户ID | 1 |
| requestData | RoleApplyRequestParamDTO$UpdateDTO | 是 | ||
| status | string | 否 | 状态 |
com.leadwaycloud.crm.model.dto.RoleApplyRequestParamDTO$CertificationFileDTO
CRM角色申请资质文件DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| fileId | string | 是 | 资质文件ID | |
| fileType | string | 是 | 资质文件ID类型:CertificationFileTypeEnum | |
| expirationTime | string(date-time) | 是 | 过期时间 | |
| qualificationName | string | 否 | 资质名称 |
com.leadwaycloud.crm.model.dto.RoleApplyRequestParamDTO$UpdateDTO
编辑CRM角色申请信息DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| image | string | 否 | 图片 | |
| settlementMethod | string | 是 | 结算类型 | |
| origin | string | 否 | 来源 | |
| supplierCategoryIdList | integer(int64)[] | 否 | 供应商分组Id | |
| addContactDTO | ContactDTO$UpdateDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| certificationFileList | RoleApplyRequestParamDTO$CertificationFileDTO[] | 否 | 资质文件集合 | |
| stamp | string | 否 | 印章 | |
| signature | string | 否 | 签字 | |
| internal | boolean | 否 | 内外部区分 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| addSupplierContactPersonDTO | CrmSupplierContactPersonDTO$AddDTO[] | 否 | 供应商联系人信息 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmRoleApplyRecord | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmRoleApplyRecord
角色申请表
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| types | string | 是 | 类型 | |
| userId | integer(int64) | 是 | 用户ID | |
| requestParam | string | 是 | 申请数据 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| companyId | integer(int64) | 是 | 公司ID | |
| applyType | string | 否 | 申请类型 | |
| status | string | 否 | 状态 | |
| partnerId | integer(int64) | 否 | CRM对象ID | |
| externalProcessInstanceId | string | 否 | 外部流程实例ID | |
| reason | string | 否 | 申请理由 | |
| origin | string | 否 | 来源 |
com.leadwaycloud.crm.model.dto.CrmCarrierDTO$UpdateDTO
修改承运商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "PERSONAL" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| contactDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
com.leadwaycloud.crm.model.dto.AgentCompanyDTO$AddDTO
添加代理商公司DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 否 | 公司Id集合 | |
| businessId | integer(int64) | 否 | 代理商ID,承运商Id |
com.leadwaycloud.crm.model.dto.CrmAgentDTO$UpdateDTO
修改代理商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| code | string | 否 | 编号 | |
| currencyId | integer(int64) | 否 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "男" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 否 | 公司类型 | "PERSONAL" |
| status | string | 否 | 状态 | "DELETE" |
| image | string | 否 | 图片 | |
| contactDTO | ContactDTO$UpdateDTO | 否 | ||
| updateFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$UpdateDTO | 否 | ||
| updateFinancePaymentBankDTO | FinancePaymentBankDTO$UpdateDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
com.leadwaycloud.crm.model.dto.AddressDTO$UpdateStatusDTO
编辑地址状态DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| addressIdList | integer(int64)[] | 是 | 地址ID集合 | |
| status | string | 是 | 状态 |
com.leadwaycloud.crm.model.dto.AddressDTO$UpdateDTO
编辑地址DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 名称 | |
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 否 | 详细地址 | |
| mobile | string | 否 | 手机 | |
| receiver | string | 否 | 收件人 | |
| externalCode | string | 否 | 外部编号 |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewTemplateDTO$AddDTO
添加模板DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| ruleId | integer(int64) | 是 | 规则ID | 1 |
| name | string | 否 | 名称 | "1" |
| content | string | 否 | 内容 | "1" |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewRuleDTO$AddDTO
添加规则DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 编号 | "1" |
| frequency | string | 否 | 频率(月、季度、年) | "1" |
| supplierId | string | 否 | 供应商ID 多个用,分隔 | "1" |
| contractId | string | 否 | 合同ID 多个用,分隔 | "1" |
| contractAmount | string | 否 | 合同金额 | "1" |
| currencyId | integer(int64) | 否 | 货币符号ID | |
| exchangeRate | number(double) | 否 | 兑换本公司汇率 | |
| merge | boolean | 否 | 兑换本公司汇率 | |
| triggerDays | boolean | 否 | 频率触发日(1-31号) | |
| triggerMonth | boolean | 否 | 频率触发月(本月CURRENT_MONTH、次月FOLLOWING_MONTH) | |
| note | string | 否 | 备注 | "1" |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewRule | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
供应评审规则
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| code | string | 否 | 编号 | |
| name | string | 否 | 编号 | |
| active | boolean | 是 | 是否可用 | true |
| frequency | string | 否 | 频率(月、季度、年) | |
| supplierId | string | 否 | 供应商ID 多个用,分隔 | |
| contractId | string | 否 | 合同ID 多个用,分隔 | |
| contractAmount | number(double) | 否 | 合同金额 | |
| currencyId | integer(int64) | 否 | 货币符号ID | |
| exchangeRate | number(double) | 否 | 兑换本公司汇率 | |
| merge | boolean | 否 | 是否合并满足规则数据 | |
| triggerDays | integer(int32) | 否 | 频率触发日(1-31号) | |
| triggerMonth | string | 否 | 频率触发月 | |
| note | string | 否 | 备注 | |
| currency | SysCurrency | 否 | ||
| supplierList | CrmSupplier[] | 否 | 供应商集合 | |
| contractList | StockContract[] | 否 | 合同集合 |
com.leadwaycloud.crm.model.entity.stock.StockContract
合同
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| pickingType | string | 是 | 订单类型 | |
| status | string | 是 | 合同状态 | |
| name | string | 否 | 合同名称 | |
| doneTime | string(date-time) | 否 | 完成时间 | |
| code | string | 是 | 合同编号 | |
| externalCode | string | 否 | 外部编号 | |
| currencyId | integer(int64) | 是 | 货币符号ID | |
| exchangeRate | number(double) | 是 | 汇率 | |
| operatorUserId | integer(int64) | 是 | 操作用户ID | |
| partnerId | integer(int64) | 是 | 客户关系对象 | |
| taxType | string | 是 | 税金计算类型 | |
| amountTotal | number(double) | 否 | 含税总额 | |
| amountTax | number(double) | 否 | 税总额 | |
| amountUntaxed | number(double) | 否 | 不含税总额 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| companyId | integer(int64) | 是 | 公司ID | |
| note | string | 否 | 备注 | |
| startDate | string(date) | 是 | 开始时间 | |
| endDate | string(date) | 是 | 结束时间 | |
| originId | integer(int64) | 否 | 源订单ID | |
| originType | string | 否 | 源订单类型 | |
| departmentId | integer(int64) | 否 | 部门ID | |
| advance | boolean | 否 | 是否预付 | |
| advanceRatio | number(double) | 否 | 预付比例 | |
| reviewMethod | string | 否 | 评审方式 | |
| signDate | string(date) | 否 | 签订日期 | |
| signLocation | string | 否 | 签署地点 | |
| contractType | string | 否 | 合同类型（正式合同,预投合同,科研合同） | |
| saleDestination | string | 否 | 销售去向 | |
| producePlanMode | string | 否 | 生产组织方式（内厂/外厂生产） | |
| version | string | 否 | 版本号 | |
| machineType | string | 否 | 机型 | |
| checkEffectiveAmount | boolean | 否 | 是否检查有效金额 | |
| contractEffectiveType | string | 否 | 合同有效类型 | |
| history | boolean | 否 | 是否是历史合同 | |
| goodsType | string | 否 | 合同商品类型 | |
| decalsContract | boolean | 否 | 是否开口合同，用于采购单金额验证(标准类型商品)-万航 | |
| excessRatio | number(double) | 否 | 超出额度比例，用于采购单金额验证(原材料类型商品)-万航 | |
| goodsSubType | string | 否 | 合同商品子类型 | |
| origin | string | 否 | 来源 | |
| initialization | boolean | 否 | 是否初始化数据 | |
| executedAmountTotal | number(double) | 否 | 期初已执行金额（含税） | |
| executedAmountUntaxed | number(double) | 否 | 期初已执行金额（不含税） | |
| executedAmountTax | number(double) | 否 | 期初已执行税总额 | |
| warrantyRatio | number(double) | 否 | 合同总价款中用作质量保证的预留金比例 | |
| warrantyPeriod | string | 否 | 项目质量保修期限(支持单位：年、月、天，默认为月) | |
| extensionInfo | string | 否 | 额外属性 |
com.leadwaycloud.crm.model.dto.CrmSupplierReviewDataDTO$AddDTO
新增数据DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | |
| templateId | integer(int64) | 是 | 评审模板ID | |
| templateVersion | string | 是 | 评审模板版本 | |
| ruleId | integer(int64) | 是 | 规则ID | |
| name | string | 否 | 名称 | |
| purchaseData | string | 否 | 采购数据 | |
| appendData | string | 否 | 附加参数 | |
| note | string | 否 | 附加参数 | |
| status | string | 否 | 状态 | |
| result | string | 否 | 结果 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewData | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
供应评审数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 是 | 商户ID | |
| templateId | integer(int64) | 是 | 评审模板ID | |
| templateVersion | string | 是 | 评审模板版本 | |
| ruleId | integer(int64) | 是 | 规则ID | |
| name | string | 否 | 名称 | |
| purchaseData | string | 否 | 采购数据 | |
| appendData | string | 否 | 附加参数 | |
| note | string | 否 | 附加参数 | |
| status | string | 是 | 状态 | |
| result | string | 否 | 结果 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson[] | 否 | 返回数据 |
com.leadwaycloud.crm.model.dto.SupplierCategoryDTO$AddDTO
添加供应商分组
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.dto.SupplierCompanyStatusDTO$UpdateDTO
编辑供应商与公司绑定关系DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| relationIdList | integer(int64)[] | 是 | 绑定关系ID集合 | |
| status | string | 是 | 状态 | "ACTIVE" |
| settlementMethod | string | 是 | 供应商结算类型-爱达 | |
| cooperationStatus | string | 是 | 供应商合作状态 |
com.leadwaycloud.crm.model.dto.SupplierDistributeDTO$AddDTO
供应商下发模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyIdList | integer(int64)[] | 是 | 公司ID集合 | |
| supplierIdList | integer(int64)[] | 是 | 供应商ID集合 |
com.leadwaycloud.crm.model.dto.SupplierOutletsDTO$AddDTO
添加供应商网点DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| name | string | 是 | 名称 | "银泰城永辉超市" |
| code | string | 是 | 标识 | "...." |
| type | string | 是 | 类型 | "SELF_PICKUP_OUTLETS" |
| contactPerson | string | 是 | 联络人 | "张三" |
| phone | string | 是 | 电话 | "13888888888" |
| address | string | 否 | 地址 | "银泰城负一楼永辉超市" |
| status | string | 是 | 状态 | "ACTIVE" |
| latLon | string | 是 | 经纬度（纬度,经度） | "104.064737,30.547256" |
| openingTime | LocalTime | 否 | ||
| closingTime | LocalTime | 否 | ||
| image | string | 否 | 图片 |
com.leadwaycloud.core.model.RJava.lang.Long
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |
com.leadwaycloud.crm.model.dto.CrmSupplierDTO$QueryDTO
查询供应商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| type | string | 否 | 公司类型 | "PERSONAL" |
| name | string | 否 | 名称 | |
| companyId | integer(int64) | 否 | 绑定公司ID | 1 |
| code | string | 否 | 编号 | |
| externalCode | string | 否 | 外部编号 | |
| statusList | string | 否 | 状态 | "ACTIVE" |
| phone | string | 否 | 电话 | |
| mobile | string | 否 | 手机 | |
| supplierCompanyRelationStatus | string | 否 | 供应商绑定状态 | "ACTIVE" |
| categoryId | integer(int64) | 否 | 供应商分组Id | |
| internal | boolean | 否 | 内外部区分 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| cooperationStatus | string | 否 | 供应商合作状态 | |
| distributionMode | string | 否 | 经销模式 | |
| level | string | 否 | 等级 | |
| paymentRequire | string | 否 | 付款条件 | |
| goodsCategoryId | string | 否 | 产品分类ID | |
| origin | string | 否 | 来源 | |
| queryFinancePaymentBank | boolean | 否 | 是否查询银行付款信息 | |
| querySupplierContactPerson | boolean | 否 | 是否查询供应商联系人信息 | |
| joinQueryCrmSupplierCompanyRelation | boolean | 否 | ||
| queryExtensionInfo | boolean | 否 | ||
| joinQueryResContact | boolean | 否 | ||
| joinQueryResPartner | boolean | 否 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTO$ExportPropertyDTO
导出配置
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| maxLine | integer(int32) | 否 | 最大导出条数 -1默认不限制条数 | |
| hideHeader | boolean | 否 | 是否隐藏表头 | |
| pageSize | integer(int32) | 否 | 分页查询条数 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTO$SheetPropertyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| sheetNum | integer(int32) | 否 | sheet页下标 | |
| sheetName | boolean | 否 | sheet页名称 | |
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmSupplierDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmSupplierDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.plug.poi.model.dto.ReportColumnDTO
选择导出列模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| key | string | 否 | 导出列名称 | |
| name | string | 否 | 导出列名称，用户导出文件可执行导入 | |
| fakeHeadName | string | 否 | 导出列展示名称,不传递默认获取name值进行展示 | |
| columnList | ReportColumnDTO[] | 否 | 子集 |
com.leadwaycloud.crm.model.dto.ContactDTO$AddDTO
添加角色联系地址信息DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 否 | 详细地址 | |
| postcode | string | 否 | 邮编 | |
| phone | string | 否 | 电话 | |
| phoneExtension | string | 否 | 电话-分机号 | |
| mobile | string | 否 | 手机 | |
| fax | string | 否 | 传真 | |
| faxExtension | string | 否 | 传真-分机号 | |
| string | 否 | 邮箱 | ||
| langId | integer(int64) | 否 | 语言 | |
| houseNumber | string | 否 | 门牌号 |
com.leadwaycloud.crm.model.dto.CrmSupplierDTO$AddDTO
添加供应商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| settlementMethod | string | 否 | 结算类型 | |
| shortName | string | 否 | 简称 | |
| source | string | 否 | 来源 | |
| sourceInfo | string | 否 | 来源补充信息 | |
| distributionMode | string | 否 | 经销模式 | |
| enterpriseType | string | 否 | 企业类型 | |
| operatingStatus | string | 否 | 经营状态 | |
| abnormalStatusReason | string | 否 | 经营状态异常说明 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredAddress | string | 否 | 注册地址 | |
| status | string | 否 | 状态 | "DELETE" |
| origin | string | 否 | 来源 | |
| eligible | boolean | 否 | 是否合格供应商 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| extensionInfo | string | 否 | 供应商额外属性 | |
| cooperationStatus | string | 是 | 供应商合作状态 | |
| supplierCategoryIdList | integer(int64)[] | 否 | 供应商分组Id集合 | |
| contact | ContactDTO$AddDTO | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| financePaymentBankList | FinancePaymentBankDTO$AddDTO[] | 否 | 供应商付款信息集合 | |
| supplierContactPersonList | CrmSupplierContactPersonDTO$AddDTO[] | 否 | 供应商联系人集合 | |
| epo | boolean | 否 | 是否开启E订单 | |
| restrictType | string | 否 | 采购限制类型 | |
| restrictQty | number(double) | 否 | 采购限制数量 | |
| orderExpiredClose | boolean | 否 | 是否开启订单过期关闭 | |
| orderValidity | integer(int32) | 否 | 订单有效期 |
com.leadwaycloud.crm.model.dto.FinanceInvoiceTitleDTO$AddDTO
添加发票抬头DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| headerName | string | 否 | 抬头名称 | |
| address | string | 否 | 地址 | |
| taxNo | string | 否 | 税号 | |
| phone | string | 否 | 电话 | |
| bank | string | 否 | 开户银行 | |
| bankAccounts | string | 否 | 银行账户 | |
| recipient | string | 否 | 收件人 | |
| mailAddress | string | 否 | 邮寄地址 | |
| receivePhone | string | 否 | 收件人手机或电话 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| billingPeriod | integer(int32) | 否 | 账期 | |
| def | boolean | 否 | 是否默认 | |
| externalCode | string | 否 | 外部编号 | |
| invoiceType | string | 否 | 发票类型 |
com.leadwaycloud.crm.model.dto.FinancePaymentBankDTO$AddDTO
添加付款信息详情DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| stateId | integer(int64) | 否 | 省、直辖市ID | 1 |
| countryId | integer(int64) | 否 | 国家 | 1 |
| cityId | integer(int64) | 否 | 城市ID | 1 |
| areaId | integer(int64) | 否 | 区、县ID | 1 |
| streetId | integer(int64) | 否 | 街道ID | 1 |
| streets | string | 否 | 其他街道详情 | |
| name | string | 否 | 开户行名称 | |
| bankCode | string | 否 | 银行代码 | |
| bankAccount | string | 否 | 账户名/账户持有人名称 | |
| accountNumber | string | 否 | 银行账户/账户持有人账号 | |
| ibanCode | string | 否 | IBAN编码 | |
| swiftCode | string | 否 | 国际银行间跨境汇款通用代码 | |
| abaRouting | string | 否 | ABA美航账户号 | |
| intermediaryBank | string | 否 | 中间银行 | |
| billingPeriod | integer(int64) | 否 | 付款账期 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| cnapsCode | string | 否 | 联行号 | |
| def | boolean | 否 | 是否默认 | |
| reference | string | 否 | 参考明细 | |
| invoiceMethod | string | 否 | 开票方式 | |
| tax | string | 否 | 税率 |
com.leadwaycloud.crm.model.dto.CrmProducerDTO$QueryDTO
查询生产商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| type | string | 否 | 公司类型 | "PERSONAL" |
| name | string | 否 | 名称 | |
| companyId | integer(int64) | 否 | 绑定公司ID | 1 |
| code | string | 否 | 编号 | |
| externalCode | string | 否 | 外部编号 | |
| statusList | string | 否 | 状态 | "ACTIVE" |
| phone | string | 否 | 电话 | |
| mobile | string | 否 | 手机 | |
| joinQueryResContact | boolean | 否 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmProducerDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmProducerDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.model.dto.CrmProducerDTO$AddDTO
添加生产商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| dependency | string | 否 | 属地 | |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
com.leadwaycloud.crm.model.dto.AddressDTO$AddDTO
添加地址DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| partnerId | integer(int64) | 否 | CRM关系ID | |
| name | string | 是 | 名称 | |
| countryId | integer(int64) | 否 | 国家ID | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| cityId | integer(int64) | 否 | 城市ID | |
| areaId | integer(int64) | 否 | 区、县ID | |
| streetId | integer(int64) | 否 | 街道ID | |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| receiver | string | 是 | 收件人 | |
| def | boolean | 否 | 是否默认地址 | |
| type | string | 是 | 类型 | |
| externalCode | string | 否 | 外部编号 | |
| origin | string | 否 | 来源 |
com.leadwaycloud.crm.model.dto.CustomerContactPersonDTO$AddDTO
添加联系地址DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| customerId | integer(int64) | 是 | 客户Id | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| status | string | 否 | 状态 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| code | string | 否 | 编号 | |
| origin | string | 否 | 来源 | |
| externalCode | string | 否 | 外部编号 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddAgentDTO
添加代理商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| contact | ContactDTO$AddDTO | 否 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddCarrierDTO
添加承运商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| contact | ContactDTO$AddDTO | 否 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddCustomerDTO
添加客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| categoryId | integer(int64) | 否 | 供应商分组Id | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| status | string | 否 | 状态 | |
| contact | ContactDTO$AddDTO | 否 | ||
| contactPersonList | CustomerContactPersonDTO$AddDTO[] | 否 | 客户联系人集合 | |
| receiveAddressList | AddressDTO$AddDTO[] | 否 | 收货地址集合 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddDTO
添加CRM关系DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| supplier | PartnerDTO$AddSupplierDTO | 否 | ||
| producer | PartnerDTO$AddProducerDTO | 否 | ||
| agent | PartnerDTO$AddAgentDTO | 否 | ||
| carrier | PartnerDTO$AddCarrierDTO | 否 | ||
| customer | PartnerDTO$AddCustomerDTO | 否 | ||
| member | PartnerDTO$AddMemberDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$AddDTO[] | 否 | 添加发票抬头集合 | |
| financePaymentBankList | FinancePaymentBankDTO$AddDTO[] | 否 | 添加付款信息集合 | |
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddMemberDTO
添加会员DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| otherBarcode | string | 否 | 第三方条码 | |
| openId | string | 否 | openId | |
| name | string | 是 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 是 | 性别 | "0" |
| appId | string | 否 | appId | |
| birthday | string(date) | 否 | 生日 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源 | "ERP" |
| memberTypeId | integer(int64) | 是 | 会员类型 | 1 |
| firstName | string | 否 | 姓 | "1" |
| lastName | string | 否 | 名 | "1" |
| barcode | string | 否 | 会员号 | |
| customerId | integer(int64) | 否 | 客户ID | |
| accountTypeCodeList | string[] | 否 | 开通账户编号 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddProducerDTO
添加生产商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| code | string | 否 | 编号 | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| currencyId | integer(int64) | 是 | 货币 | |
| image | string | 否 | 图片 | |
| contact | ContactDTO$AddDTO | 否 |
com.leadwaycloud.crm.model.dto.PartnerDTO$AddSupplierDTO
添加供应商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| categoryId | integer(int64) | 否 | 供应商分组Id | |
| contact | ContactDTO$AddDTO | 否 | ||
| settlementMethod | string | 否 | 结算类型 | |
| origin | string | 否 | 来源 | |
| supplierContactPersonList | CrmSupplierContactPersonDTO$AddDTO[] | 否 | 供应商联系人集合 | |
| supplierCategoryIdList | integer(int64)[] | 否 | 供应商分组Id | |
| eligible | boolean | 否 | 是否合格供应商 |
com.leadwaycloud.crm.model.dto.MemberTypeUpgradeRuleDTO$AddDTO
添加会员晋级规则模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 所属商户ID | 1 |
| name | string | 是 | 名称 | |
| online | boolean | 是 | 是否上线 | true |
| upgradeRuleDetailDTOList | MemberTypeUpgradeRuleDetailDTO[] | 是 | 规则 |
com.leadwaycloud.crm.model.dto.MemberTypeBuyRuleDTO$AddDTO
添加付费晋级规则模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 所属商户ID | 1 |
| name | string | 是 | 购买活动名称 | |
| currentMemberTypeId | integer(int64) | 是 | 当前的会员类型ID | 1 |
| buyMemberTypeId | integer(int64) | 是 | 购买的会员类型 | 1 |
| validDay | integer(int32) | 否 | 有效日(在会员成为该类型多少天后，需还原为变更前的类型。未设置则表示永久) | |
| startDate | string(date) | 是 | 开始日期 | |
| endDate | string(date) | 是 | 结束时间 | |
| online | boolean | 是 | 是否上线 | true |
| memberTypeBuyRuleGiftDTOList | MemberTypeBuyRuleGiftDTO[] | 否 | 赠送详情 | |
| memberBuyRuleTenderDTOList | MemberBuyRuleTenderDTO[] | 是 | 支付规则 |
com.leadwaycloud.crm.model.dto.MemberTypeDTO$AddDTO
添加会员类型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | |
| code | string | 是 | 编号 | |
| description | string | 否 | 描述 | |
| system | boolean | 否 | 是否是系统创建角色 | true |
com.leadwaycloud.crm.model.dto.MemberFeedBackDTO$AddDTO
添加留言
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户Id | |
| companyId | integer(int64) | 是 | 公司Id | |
| memberId | string | 是 | 会员Id | |
| channel | string | 否 | 渠道 | |
| feedbackTypeEnum | string | 是 | 反馈类型 | |
| originId | integer(int64) | 否 | 对应类型事物ID | |
| subject | string | 否 | 主题 | |
| comment | string | 否 | 留言 | |
| replys | string | 否 | 回复 | |
| status | string | 是 | 状态 |
com.leadwaycloud.crm.model.dto.MemberDTO$QueryDTO
查询会员模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| status | string | 否 | 状态: ACTIVE:活跃的 LOCK:锁定的 | "ACTIVE" |
| name | string | 否 | 名称 | |
| mobilePhone | string | 否 | 手机 | |
| source | string | 否 | 会员来源 | |
| memberTypeName | string | 否 | 会员类型名称 | |
| barcode | string | 否 | 会员号 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| memberTypeId | integer(int64) | 否 | 会员类型ID | 1 |
| otherBarcode | string | 否 | 第三方条码 | |
| idList | integer(int64) | 否 | 主键ID集合 | 1 |
| customerId | integer(int64) | 否 | 客户ID |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.MemberDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | MemberDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.model.dto.MemberTypeBuyDiscountDTO$AddDTO
添加折扣模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| name | string | 是 | 名称 | |
| discValue | number(double) | 是 | 折扣值 | |
| status | string | 是 | 状态 | "AVAILABLE" |
| channel | string | 是 | 促销渠道 | |
| startTime | string(date) | 是 | 开始时间 | |
| endTime | string(date) | 是 | 结束时间 | |
| buyRuleId | integer(int64) | 是 | 付费规则ID | 1 |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.dto.MemberContactDTO$AddDTO
添加会员地址模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| memberId | integer(int64) | 是 | 会员ID | 1 |
| countryId | integer(int64) | 是 | 国家ID | 1 |
| provinceId | integer(int64) | 是 | 省、直辖市 | 1 |
| cityId | integer(int64) | 是 | 城市 | 1 |
| areaId | integer(int64) | 是 | 区、县 | 1 |
| streetId | integer(int64) | 否 | 街道 | 1 |
| address | string | 是 | 详细地址 | |
| mobile | string | 是 | 手机 | |
| name | string | 是 | 名称 | |
| def | boolean | 否 | 默认 | false |
com.leadwaycloud.crm.model.dto.MemberDTO$AddDTO
添加会员模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| otherBarcode | string | 否 | 第三方条码 | |
| openId | string | 否 | openId | |
| name | string | 是 | 名称 | |
| realName | string | 否 | 真实名称 | |
| sex | string | 是 | 性别 | "0" |
| appId | string | 否 | appId | |
| birthday | string(date) | 否 | 生日 | |
| string | 否 | 邮箱 | ||
| mobilePhone | string | 否 | 手机号 | |
| image | string | 否 | 图片 | |
| source | string | 是 | 会员来源 | "ERP" |
| memberTypeId | integer(int64) | 是 | 会员类型 | 1 |
| firstName | string | 否 | 姓 | "1" |
| lastName | string | 否 | 名 | "1" |
| barcode | string | 否 | ||
| customerId | integer(int64) | 否 | 客户ID | |
| accountTypeCodeList | string[] | 否 | 开通账户编号 | |
| origin | string | 否 | 来源 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
com.leadwaycloud.crm.model.dto.MemberAccountTypeDTO$AddDTO
添加账户类型DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| code | string | 是 | 编号(只允许字母) | "BALANCE" |
| name | string | 是 | 名称 | |
| changeValue | number(double) | 否 | 兑换值 |
com.leadwaycloud.crm.model.dto.DeliveryPersonDTO$QueryDTO
查询配送人员DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyId | integer(int64) | 否 | 公司ID | |
| name | string | 否 | 姓名 | |
| type | string | 否 | 类型 | |
| affiliatedCompany | string | 否 | 所属公司 | |
| code | string | 否 | 人员编码 | |
| externalCode | string | 否 | 外部编码 | |
| statusList | string | 否 | 状态 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.DeliveryPersonDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | DeliveryPersonDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.model.dto.DeliveryPersonDTO$AddDTO
添加配送人员DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | string | 是 | 类型 | |
| name | string | 是 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司 | |
| externalCode | string | 否 | 外部编码 | |
| note | string | 否 | 备注 | |
| companyId | integer(int64) | 否 | 公司ID |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmDeliveryPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmDeliveryPerson | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmDeliveryPerson
配送人员
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 否 | ||
| companyId | integer(int64) | 否 | ||
| code | string | 否 | ||
| type | string | 否 | ||
| name | string | 否 | ||
| affiliatedCompany | string | 否 | ||
| externalCode | string | 否 | ||
| status | string | 否 | ||
| note | string | 否 |
com.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$QueryDTO
查询配送载体DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | string | 否 | 载体类型 | |
| identifier | string | 否 | 车牌号 | |
| companyId | integer(int64) | 否 | 公司ID |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | DeliveryCarrierDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.model.dto.DeliveryCarrierDTO$AddDTO
添加配送载体DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| companyId | integer(int64) | 否 | 公司ID | |
| type | string | 否 | 载体类型，默认CAR | |
| identifier | string | 是 | 车牌号 | |
| note | string | 否 | 备注 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmDeliveryCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmDeliveryCarrier | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmDeliveryCarrier
配送载体
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| merchantId | integer(int64) | 否 | ||
| companyId | integer(int64) | 否 | ||
| type | string | 否 | ||
| identifier | string | 否 | ||
| status | string | 否 | ||
| note | string | 否 |
com.leadwaycloud.crm.model.dto.CrmCustomerCategoryDTO$AddDTO
添加客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 是 | 编号 | |
| name | string | 是 | 名称 | |
| status | string | 否 | 状态 | |
| parentId | integer(int64) | 否 | CRM对象ID | |
| idChain | string | 否 | 完整的组织结构 | |
| images | string | 否 | 图片地址 | |
| merchantId | integer(int64) | 否 | 总部ID | |
| externalCode | string | 否 | 外部编号 | |
| description | string | 否 | 描述 |
com.leadwaycloud.crm.model.dto.CrmCustomerDTO$QueryDTO
查询客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | |
| companyId | integer(int64) | 是 | 公司ID | |
| code | string | 否 | 编号 | |
| type | string | 否 | 类型(公司/个人) | |
| name | string | 否 | 名称 | |
| externalCode | string | 否 | 外部编号 | |
| statusList | string[] | 否 | 状态 | |
| phone | string | 否 | 电话 | |
| mobile | string | 否 | 手机 | |
| creditLevel | string | 否 | 信用等级 | |
| originList | string[] | 否 | 来源集合 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| certificationAuditStatus | string | 否 | 认证审核状态 | |
| joinQueryResContact | boolean | 否 |
com.leadwaycloud.crm.plug.poi.model.dto.ExportDTOCom.leadwaycloud.crm.model.dto.CrmCustomerDTO$QueryDTO
公共导出模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| reportColumnList | ReportColumnDTO[] | 是 | 需导出参数集合 | |
| queryDTO | CrmCustomerDTO$QueryDTO | 是 | ||
| fileName | string | 是 | 导出文件名 | |
| exportProperty | ExportDTO$ExportPropertyDTO | 否 | ||
| sheetPropertyList | ExportDTO$SheetPropertyDTO[] | 否 | 各Sheet的导出列配置 |
com.leadwaycloud.crm.model.dto.CrmCustomerDTO$AddDTO
添加客户DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 类型(公司/个人) | |
| merchantId | integer(int64) | 是 | 商户ID | |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| firstName | string | 否 | 姓 | |
| lastName | string | 否 | 名 | |
| creditLevel | string | 否 | 信用等级 | |
| origin | string | 否 | 来源 | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| unifiedSocialCreditCode | string | 否 | 统一社会信用代码 | |
| businessLicenseNumber | string | 否 | 营业执照 | |
| legalRepresentative | string | 否 | 法定代表人 | |
| registeredCapital | number(double) | 否 | 注册资本 | |
| establishmentDate | string(date) | 否 | 成立日期 | |
| businessScope | string | 否 | 经营范围 | |
| registeredAddress | string | 否 | 注册地址 | |
| website | string | 否 | 官网 | |
| industryCode | string | 否 | 行业代码 | |
| industryName | string | 否 | 行业名称 | |
| shortName | string | 否 | 客户简称 | |
| cooperationStatus | string | 否 | 客户合作状态 | |
| status | string | 否 | 状态 | |
| certification | boolean | 否 | 是否认证 | |
| credit | boolean | 否 | 是否信用客户 | |
| extensionInfo | string | 否 | 额外属性 | |
| certificationAuditStatus | string | 否 | 认证审核状态 | |
| contact | ContactDTO$AddDTO | 否 | ||
| financeInvoiceTitleList | FinanceInvoiceTitleDTO$AddDTO[] | 否 | 发票抬头集合 | |
| contactPersonList | CustomerContactPersonDTO$AddDTO[] | 否 | 客户联系人集合 | |
| receiveAddressList | AddressDTO$AddDTO[] | 否 | 收货地址集合 |
com.leadwaycloud.crm.plug.workflow.model.CallbackDTO
workflow-回调参数
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | string | 否 | 业务状态 | |
| submitUserId | string | 否 | 提交人ID | |
| businessKey | string | 否 | 流程KEY(老业务KEY) | |
| businessId | string | 是 | 业务ID | |
| taskId | string | 否 | 节点ID | |
| body | string | 是 | 业务数据 | |
| businessTypeKey | string | 否 | 流程KEY(新业务KEY) | |
| key | string | 否 |
com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |
com.leadwaycloud.crm.model.dto.RoleApplyRecordDTO$AddDTO
添加CRM角色申请DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| typeList | string | 否 | 类型 | "[\"SUPPLIER\"]" |
| string | 是 | 邮箱 | "kunliang.zeng@leadwaycloud.com" | |
| pwd | string | 否 | 密码 | "MD5(pwd)" |
| name | string | 是 | 用户名称 | "kunliang.zeng" |
| language | string | 是 | 系统语言 | "zh_CN" |
| image | string | 否 | 图片 | "xxxxx" |
| requestData | RoleApplyRequestParamDTO$UpdateDTO | 是 | ||
| applyType | string | 是 | CRM角色申请类型 | |
| origin | string | 否 | 来源 |
com.leadwaycloud.crm.shell.model.dto.ShellSPSupplierDTO
storePoint-供应商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| supplier_code | string | 是 | 供应商Code | "0001" |
| name | string | 否 | 名称 | |
| address | string | 否 | 地址 | |
| city | string | 否 | 城市 | |
| state | string | 否 | 省份 | |
| postal | string | 否 | 邮编 | |
| phone | string | 否 | 电话 | |
| fax | string | 否 | 传真 | |
| bank_code | string | 否 | 银行代码 | |
| bank_account | string | 否 | 账号 | |
| tax_no | string | 否 | 税编号 | |
| string | 否 | 邮箱 |
com.leadwaycloud.crm.model.dto.CrmCarrierDTO$AddDTO
添加承运商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | "0" |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | "PERSONAL" |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
com.leadwaycloud.crm.model.dto.CrmAgentDTO$AddDTO
添加代理商DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| name | string | 是 | 名称 | |
| currencyId | integer(int64) | 是 | 货币ID | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| image | string | 否 | 图片 | |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| addContactDTO | ContactDTO$AddDTO | 否 | ||
| addFinanceInvoiceTitleDTO | FinanceInvoiceTitleDTO$AddDTO | 否 | ||
| addFinancePaymentBankDTO | FinancePaymentBankDTO$AddDTO | 否 | ||
| qualificationInfo | string | 否 | 资质信息JSON：包含资质文件集合（文件ID，过期时间），印章，签字等 | |
| partnerId | integer(int64) | 否 | CRM关系ID |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmAgent
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmAgent | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmAgent
代理商
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| status | string | 是 | 状态 | |
| currencyId | integer(int64) | 是 | 货币Id | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 性别 | |
| note | string | 否 | 备注 | |
| partnerId | integer(int64) | 是 | CRM对象ID | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | |
| merchantId | integer(int64) | 是 | 商户ID | |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
| contactId | integer(int64) | 否 | 地址ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 是 | 编号 | |
| currency | SysCurrency | 否 | ||
| partner | ResPartner | 否 | ||
| contact | ResContact | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitle | 否 | ||
| resCompanyList | ResCompany[] | 否 | company对象展示 | |
| financePaymentBank | FinancePaymentBank | 否 | ||
| supplierCategoryList | CrmSupplierCategory[] | 否 | 关联partner角色 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmSupplierReviewTemplate[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewTemplate | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmSupplierReviewRule[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewRule | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmSupplierReviewData[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierReviewData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierReviewData | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmSupplierContactPerson[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplierContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierContactPerson | 否 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCategory[] | 否 | 返回数据 |
com.leadwaycloud.crm.model.dto.SupplierCompanyStatusDTO$QueryDTO
查询供应商与公司绑定关系DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| supplierStatus | string | 否 | 供应商状态 | |
| supplierId | integer(int64) | 否 | 状态 | |
| companyId | integer(int64) | 否 | 供应商结算类型-爱达 | |
| cooperationStatusList | string[] | 否 | 供应商合作状态集合 | |
| supplierName | string | 否 | 供应商名称 | |
| supplierCode | string | 否 | 供应商编号 | |
| supplierType | string | 否 | 供应商类型 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplierCompanyRelation
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplierCompanyRelation[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier[] | 否 | 返回数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmSupplier[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmSupplier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmSupplier | 否 |
com.leadwaycloud.crm.model.dto.SupplierOutletsDTO$QueryDTO
查询供应商网点DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| supplierId | integer(int64) | 是 | 供应商ID | 1 |
| name | string | 否 | 名称 | "银泰城永辉超市" |
| code | string | 否 | 标识 | "...." |
| type | string | 否 | 类型 | "SELF_PICKUP_OUTLETS" |
| contactPerson | string | 否 | 联络人 | "张三" |
| phone | string | 否 | 电话 | "13888888888" |
| status | string | 否 | 状态 | "ACTIVE" |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.supplier.SupplierOutletsListVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SupplierOutletsListVO[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.supplier.SupplierOutletsListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SupplierOutletsListVO | 否 |
com.leadwaycloud.crm.model.vo.supplier.SupplierOutletsListVO
供应商网点列表VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| supplierId | integer(int64) | 否 | 供应商ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 标识 | |
| type | string | 否 | 类型 | |
| contactPerson | string | 否 | 联络人 | |
| phone | string | 否 | 电话 | |
| address | string | 否 | 地址 | |
| status | string | 否 | 状态 | |
| latLon | string | 否 | 经纬度 - 纬度,经度 | |
| openingTime | string | 否 | 开店时间 | |
| closingTime | string | 否 | 关店时间 | |
| image | string | 否 | 图片 | |
| createTime | string(date-time) | 否 | 创建时间 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.supplier.SupplierOutletsDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SupplierOutletsDetailVO | 否 |
com.leadwaycloud.crm.model.vo.supplier.SupplierOutletsDetailVO
供应商网点详情VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| supplierId | integer(int64) | 否 | 供应商ID | |
| name | string | 否 | 名称 | |
| code | string | 否 | 标识 | |
| type | string | 否 | 类型 | |
| contactPerson | string | 否 | 联络人 | |
| phone | string | 否 | 电话 | |
| address | string | 否 | 地址 | |
| status | string | 否 | 状态 | |
| latLon | string | 否 | 经纬度 - 纬度,经度 | |
| openingTime | string | 否 | 开店时间 | |
| closingTime | string | 否 | 关店时间 | |
| image | string | 否 | 图片 | |
| createTime | string(date-time) | 否 | 创建时间 |
com.leadwaycloud.crm.model.dto.CrmSupplierDTO$SupplierCheckUniqueDTO
供应商信息唯一校验DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID（用于编辑排除自己本身） | |
| name | string | 否 | 名称 |
com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmProducer
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmProducer[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer | 否 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmProducer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmProducer[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.PartnerVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PartnerVO[] | 否 | 返回数据 |
com.leadwaycloud.crm.model.entity.crm.CrmCarrier
承运商
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| status | string | 是 | 状态 | |
| currencyId | integer(int64) | 是 | 货币Id | |
| birthday | string(date) | 否 | 生日 | |
| sex | string | 否 | 生日 | |
| note | string | 否 | 性别 | |
| partnerId | integer(int64) | 是 | CRM关系 | |
| externalCode | string | 否 | 外部编号 | |
| type | string | 是 | 公司类型 | |
| merchantId | integer(int64) | 是 | 商户Id | |
| name | string | 是 | 名称 | |
| image | string | 否 | 图片 | |
| contactId | integer(int64) | 否 | 地址联系Id | |
| companyId | integer(int64) | 否 | 公司Id | |
| code | string | 是 | 编号 | |
| currency | SysCurrency | 否 | ||
| contact | ResContact | 否 | ||
| partner | ResPartner | 否 | ||
| financeInvoiceTitle | FinanceInvoiceTitle | 否 | ||
| supplierList | CrmSupplier[] | 否 | 关联供应商 | |
| resCompanyList | ResCompany[] | 否 | 承运商关联公司 | |
| financePaymentBank | FinancePaymentBank | 否 | ||
| supplierCategoryList | CrmSupplierCategory[] | 否 | 关联partner角色 |
com.leadwaycloud.crm.model.entity.hr.HrEmployee
员工
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| code | string | 是 | 编号 | |
| nationality | string | 是 | 名族 | |
| domicile | string | 是 | 户籍 | |
| status | string | 是 | 状态 | "PERIOD_OF_PROBATION" |
| entryDate | string(date) | 否 | 入职日期 | "2020-10-11" |
| positiveDate | string(date) | 否 | 转正日期 | "2020-10-11" |
| resignDate | string(date) | 否 | 离职日期 | "2020-10-11" |
| bankCard | string | 否 | 银行卡 | |
| bankCardNum | string | 否 | 银行卡号 | |
| partnerId | integer(int64) | 是 | 客户关系对象ID | |
| companyId | integer(int64) | 是 | 公司ID | |
| merchantId | integer(int64) | 是 | 商户号ID | |
| parentId | integer(int64) | 否 | 上一级ID | |
| idChain | string | 是 | 完整的组织架构值 | |
| externalCode | string | 否 | 外部编号 | |
| name | string | 否 | 名称 | |
| image | string | 否 | 头像 | |
| contactId | integer(int64) | 是 | 地址ID | |
| birthday | string(date) | 否 | 出生日期 | |
| sex | string | 否 | 性别 | |
| bank | string | 否 | 银行(名)，sys_property获取 |
com.leadwaycloud.crm.model.vo.PartnerVO
客户关系对象
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | id | |
| customer | CrmCustomer | 否 | ||
| supplier | CrmSupplier | 否 | ||
| company | ResCompany | 否 | ||
| user | ResUser | 否 | ||
| employee | HrEmployee | 否 | ||
| member | CrmMember | 否 | ||
| carrier | CrmCarrier | 否 | ||
| agent | CrmAgent | 否 | ||
| producer | CrmProducer | 否 | ||
| extensionInfo | string | 否 | 扩展数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberTypeUpgradeRule[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpgradeRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpgradeRule | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberTypeBuyRule[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyRule
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyRule | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberType[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType | 否 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberType[] | 否 | 返回数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpdateLog
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberTypeUpdateLog[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeUpdateLog | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberTypeUpdateLog
会员类型变更日志模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| memberId | integer(int64) | 是 | 会员ID | |
| source | string | 是 | 数据来源 | |
| beforeTypeId | integer(int64) | 是 | 变更前类型ID | |
| afterTypeId | integer(int64) | 是 | 变更后类型ID | |
| remark | string | 否 | 备注 | |
| beforeType | CrmMemberType | 否 | ||
| afterType | CrmMemberType | 否 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.shell.model.vo.LoyaltyMemberVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LoyaltyMemberVO | 否 |
com.leadwaycloud.crm.shell.model.vo.LoyaltyMemberVO
Loyalty会员VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| member | CrmMember | 否 | ||
| loyaltyId | string | 否 | loyaltyId | |
| retailerId | string | 否 | retailerId | |
| memberId | string | 否 | 会员ID | |
| uuid | string | 否 | uuid |
com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.MemberBindStatusVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MemberBindStatusVO | 否 |
com.leadwaycloud.crm.model.vo.MemberBindStatusVO
会员绑定状态VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| bindStatus | string | 否 | 状态 | |
| memberId | integer(int64) | 否 | 会员 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMember
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMember[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMember
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMember | 否 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.MemberVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MemberVO | 否 |
com.leadwaycloud.crm.model.vo.MemberVO
会员返回模型
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| member | CrmMember | 否 | ||
| openId | string | 否 | openID |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberFeedback[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberFeedback
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberFeedback | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberTypeBuyDiscount[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberTypeBuyDiscount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberTypeBuyDiscount | 否 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberContact
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberContact[] | 否 | 返回数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountUpdateLog
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmMemberAccountUpdateLog[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountUpdateLog
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountUpdateLog | 否 |
com.leadwaycloud.crm.model.entity.crm.CrmMemberAccountUpdateLog
会员账户变更
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ||
| createBy | integer(int64) | 否 | ||
| createTime | string(date-time) | 否 | ||
| updateBy | integer(int64) | 否 | ||
| updateTime | string(date-time) | 否 | ||
| accountId | integer(int64) | 是 | 会员账户ID | |
| channel | string | 是 | 变更数据来源 | |
| beforeValue | number(double) | 是 | 变更前价值 | |
| updateValue | number(double) | 是 | 变更值 | |
| afterValue | number(double) | 是 | 变更后价值 | |
| type | string | 是 | 变更类型 | |
| remark | string | 否 | 备注 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccountType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccountType[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmMemberAccount
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmMemberAccount[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO[] | 否 | 返回数据 |
com.leadwaycloud.crm.model.vo.address.AddressVO
地址VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| partnerId | integer(int64) | 否 | CRM关系ID | |
| name | string | 否 | 名称 | |
| address | string | 否 | 详细地址 | |
| mobile | string | 否 | 手机 | |
| receiver | string | 否 | 收件人 | |
| def | boolean | 否 | 是否默认地址 | |
| status | string | 否 | 状态 | |
| type | string | 否 | 类型 | |
| externalCode | string | 否 | 外部编号 | |
| origin | string | 否 | 来源 | |
| createTime | string(date-time) | 否 | 创建时间 | |
| updateTime | string(date-time) | 否 | 修改时间 | |
| countryId | integer(int64) | 否 | 国家ID | |
| countryName | string | 否 | 国家 | |
| stateId | integer(int64) | 否 | 省、直辖市ID | |
| stateName | string | 否 | 省 | |
| cityId | integer(int64) | 否 | 城市ID | |
| cityName | string | 否 | 市 | |
| areaId | integer(int64) | 否 | 区、县ID | |
| areaName | string | 否 | 区 | |
| streetId | integer(int64) | 否 | 街道ID | |
| streetName | string | 否 | 街道 | |
| createUserId | integer(int64) | 否 | 创建人ID | |
| createUserName | string | 否 | 创建人名称 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryPersonListVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | DeliveryPersonListVO[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryPersonListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryPersonListVO | 否 |
com.leadwaycloud.crm.model.vo.delivery.DeliveryPersonListVO
配送人员列表VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 否 | 人员编码（系统自动生成） | |
| type | string | 否 | 类型 | |
| name | string | 否 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司（业务字段，选填） | |
| externalCode | string | 否 | 外部编码 | |
| status | string | 否 | 状态 | |
| note | string | 否 | 备注 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.delivery.DeliveryPersonDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryPersonDetailVO | 否 |
com.leadwaycloud.crm.model.vo.delivery.DeliveryPersonDetailVO
配送人员详情VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| code | string | 否 | 人员编码（系统自动生成） | |
| type | string | 否 | 类型 | |
| name | string | 否 | 姓名 | |
| affiliatedCompany | string | 否 | 所属公司（业务字段，选填） | |
| externalCode | string | 否 | 外部编码 | |
| status | string | 否 | 状态 | |
| note | string | 否 | 备注 | |
| createTime | string(date-time) | 否 | 创建时间 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | DeliveryCarrierListVO[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierListVO | 否 |
com.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
配送载体列表VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| type | string | 否 | 载体类型 | |
| identifier | string | 否 | 载体标识号（车牌号等） | |
| status | string | 否 | 状态 | |
| note | string | 否 | 备注 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierListVO[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DeliveryCarrierDetailVO | 否 |
com.leadwaycloud.crm.model.vo.delivery.DeliveryCarrierDetailVO
配送载体详情VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| type | string | 否 | 载体类型 | |
| identifier | string | 否 | 载体标识号（车牌号等） | |
| status | string | 否 | 状态 | |
| note | string | 否 | 备注 | |
| createTime | string(date-time) | 否 | 创建时间 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.customer.CustomerContactPersonListVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CustomerContactPersonListVO[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.customer.CustomerContactPersonListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CustomerContactPersonListVO | 否 |
com.leadwaycloud.crm.model.vo.customer.CustomerContactPersonListVO
客户联系人列表VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | id | |
| phone | string | 否 | 电话 | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| jobPosition | string | 否 | 工作岗位 | |
| title | string | 否 | 称谓 | |
| note | string | 否 | 备注 | |
| customerId | integer(int64) | 否 | 客户Id | |
| merchantId | integer(int64) | 否 | 商户Id | |
| mobile | string | 否 | 手机 | |
| def | boolean | 否 | 是否默认 | |
| decisionMaker | boolean | 否 | 是否决策人 | |
| contactPreference | string | 否 | 联系人偏好 | |
| birthday | string(date) | 否 | 生日 | |
| jobDepartment | string | 否 | 工作部门 | |
| partnerId | integer(int64) | 否 | CRM关系Id | |
| status | string | 否 | 状态 | |
| code | string | 否 | 编号 | |
| origin | string | 否 | 来源 | |
| userId | integer(int64) | 否 | 用户ID | |
| userName | string | 否 | 用户登陆账号 | |
| userStatus | string | 否 | 用户状态 | |
| userAuditStatus | string | 否 | 用户审核状态 | |
| memberId | string | 否 | 会员ID |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomerContactPerson
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerContactPerson[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomerCategory
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomerCategory[] | 否 | 返回数据 |
com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer[] | 否 | 返回数据 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmCustomer[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCustomer
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCustomer | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.RoleApplyRecordListVO
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | RoleApplyRecordListVO[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.vo.RoleApplyRecordListVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RoleApplyRecordListVO | 否 |
com.leadwaycloud.crm.model.vo.RoleApplyRecordListVO
CRM角色申请列表VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| types | string | 否 | 类型 | |
| userId | integer(int64) | 否 | 用户ID | |
| requestParam | string | 否 | 申请数据 | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| applyType | string | 否 | 申请类型 | |
| status | string | 否 | 状态 | |
| createTime | string(date-time) | 否 | 创建时间 | |
| updateTime | string(date-time) | 否 | 编辑时间 | |
| origin | string | 否 | 来源 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.RoleApplyRecordDetailVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | RoleApplyRecordDetailVO | 否 |
com.leadwaycloud.crm.model.vo.RoleApplyRecordDetailVO
CRM角色申请详情VO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| id | integer(int64) | 否 | ID | |
| types | string | 否 | 类型 | |
| userId | integer(int64) | 否 | 用户ID | |
| requestParam | string | 否 | 申请数据 | |
| merchantId | integer(int64) | 否 | 商户ID | |
| companyId | integer(int64) | 否 | 公司ID | |
| applyType | string | 否 | 申请类型 | |
| status | string | 否 | 状态 | |
| createTime | string(date-time) | 否 | 创建时间 | |
| updateTime | string(date-time) | 否 | 编辑时间 | |
| string | 否 | 注册邮箱数据 | ||
| reason | string | 否 | 申请理由 | |
| origin | string | 否 | 来源 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCarrier
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmCarrier[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCarrier | 否 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.entity.crm.CrmCarrier
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmCarrier | 否 |
com.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmAgent
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | CrmAgent[] | 否 | 当前页数据 |
com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.crm.model.entity.crm.CrmAgent
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CrmAgent | 否 |
com.leadwaycloud.core.model.RCom.leadwaycloud.crm.model.vo.address.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO | 否 |