cs.customers.list

条件分页查询客户列表

请求路由: cs.customers.list

交互模型: Request Stream

访问限制: 无

请求

RSocket.rs({
  "route" : "cs.customers.list",
  "args" : {
    "search" : "客户查询过滤参数对象",
    "pg" : "分页排序参数"
  }
});

请求参数

名称	类型	必须	说明
`search`	Object	否	客户查询过滤参数对象
`search.status`	String[]	否	客户状态集合 NORMAL - 正常 DISABLED - 禁用
`search.tags`	String[]	否	客户标签
`search.level`	String	否	客户等级过滤
`search.mainRoute`	String	否	主要航线过滤
`search.followUpStatus`	String	否	跟进状态过滤 NORMAL - 正常 OVERDUE - 超期未跟进
`search.country`	String	否	国家
`search.salespersonIds`	String[]	否	销售人员id集合
`search.department`	String	否	部门id
`search.isPublic`	Boolean	否	是否处于公海
`search.publicEnterTimeFrom`	String	否	进入公海时间 (起)
`search.publicEnterTimeTo`	String	否	进入公海时间 (止)
`search.lastShipmentDateFrom`	String	否	最晚走货日期 (起)
`search.lastShipmentDateTo`	String	否	最晚走货日期 (止)
`search.lastFollowUpDateFrom`	String	否	最晚跟进日期 (起)
`search.lastFollowUpDateTo`	String	否	最晚跟进日期 (止)
`search.ownerAssignTimeFrom`	String	否	分配时间 (起)
`search.ownerAssignTimeTo`	String	否	分配时间 (止)
`search.customerIds`	String[]	否	客户 ID 集合
`search.legalEntityIds`	String[]	否	法人主体id
`search.customerId`	String	否	客户id
`search.keyword`	String	否	模糊匹配关键字
`search.from`	String	否	查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
`search.to`	String	否	查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
`pg`	Object	否	分页排序参数
`pg.page`	Number	否	页码，首页从0开始
`pg.size`	Number	否	每页记录，默认为10
`pg.sort`	String[]	否	排序字段清单，默认为升序，需要指定降序时在字段名后面添加desc并用分号隔开。例如：["id", "crDate;desc"]

符合查询条件的客户列表 Flux 包装

[ ]

返回属性

名称	类型	说明
`customerId`	String	客户 ID，对应往来单位的 unitId
`unifiedSocialCreditCode`	String	统一社会信用代码
`companyEmail`	String	公司邮箱
`companyPhone`	String	公司电话
`companyWebsite`	String	公司网址
`registerYears`	Number	注册年限
`mainBusiness`	String	主营业务
`cargoTypes`	String[]	主要货源类型列表
`sourceChannel`	String	来源渠道(基础数据id)
`sourceChannelInfo`	Object	来源渠道信息
`sourceChannelInfo.itemId`	String	数据项唯一标识
`sourceChannelInfo.name`	String	数据项名称（中文）
`sourceChannelInfo.nameEn`	String	数据项名称（英文）
`sourceChannelInfo.extendedProperties`	Object	扩展属性用于存储一些额外的、非结构化的数据
`sourceDetail`	String	来源详情
`level`	String	客户等级(基础数据id)
`levelInfo`	Object	客户等级信息
`levelInfo.itemId`	String	数据项唯一标识
`levelInfo.name`	String	数据项名称（中文）
`levelInfo.nameEn`	String	数据项名称（英文）
`levelInfo.extendedProperties`	Object	扩展属性用于存储一些额外的、非结构化的数据
`salespersons`	Object[]	平等归属的销售人员；空列表表示客户没有销售归属。
`salespersons.[].department`	String	部门id
`salespersons.[].departmentName`	String	部门名称
`salespersons.[].username`	String	用户标识
`salespersons.[].name`	String	用户名称
`salespersons.[].nameEn`	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
`salespersons.[].mobile`	String	用户手机号
`salespersons.[].email`	String	用户邮箱
`salespersons.[].position`	String	职位
`salespersons.[].contactRoles`	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
`operators`	Object[]	负责该客户的操作人员；按用户名识别，空列表表示尚未分配。操作人员可在所属租户及获准法人主体范围内查看客户，与销售归属及公海状态独立。
`operators.[].username`	String	用户标识
`operators.[].name`	String	用户名称
`operators.[].nameEn`	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
`operators.[].mobile`	String	用户手机号
`operators.[].email`	String	用户邮箱
`operators.[].position`	String	职位
`operators.[].contactRoles`	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
`tags`	String[]	客户标签
`mainRoutes`	String[]	主要航线(基础数据id列表)
`mainRoutesInfo`	Object[]	主要航线信息列表
`mainRoutesInfo.[].itemId`	String	数据项唯一标识
`mainRoutesInfo.[].name`	String	数据项名称（中文）
`mainRoutesInfo.[].nameEn`	String	数据项名称（英文）
`mainRoutesInfo.[].extendedProperties`	Object	扩展属性用于存储一些额外的、非结构化的数据
`totalTeu`	Number	累计箱量 (TEU)
`lastShipmentDate`	String	最近走货日期(UTC)
`lastFollowUpDate`	String	最近跟进日期(UTC)
`isPublic`	Boolean	是否处于公海
`publicEnterTime`	String	进入公海时间(UTC)
`ownerAssignTime`	String	销售分配时间(UTC)
`followUpStatus`	String	跟进状态 NORMAL - 正常 OVERDUE - 超期未跟进
`isFirstOrder`	Boolean	是否首次下单
`businessInfo`	Object	商务信息
`businessInfo.settlementMode`	String	结算方式 SPOT - 票结/见款放单（账期 0 天） MONTHLY - 月结 CUSTOM - 自定义账期
`businessInfo.creditDays`	Number	账期（天）
`attachments`	Object[]	客户附件
`attachments.[].title`	String	附件标题
`attachments.[].description`	String	附件说明
`attachments.[].binaryId`	String[]	附件id
`status`	String	状态 NORMAL - 正常 DISABLED - 禁用
`name`	String	往来单位中文名（公共字段，与 Unit 同步保存）
`nameEn`	String	往来单位英文名（公共字段，与 Unit 同步保存）
`abbreviation`	String	往来单位简称（公共字段，与 Unit 同步保存）
`country`	String	往来单位所在国家/地区（公共字段，与 Unit 同步保存）
`countryEn`	String	往来单位所在国家/地区英文名（公共字段，与 Unit 同步保存）
`address`	String	往来单位中文地址（公共字段，与 Unit 同步保存）
`addressEn`	String	往来单位英文地址（公共字段，与 Unit 同步保存）
`contactPersons`	Object[]	联系人列表（公共字段，与 Unit 同步保存）
`contactPersons.[].username`	String	用户标识
`contactPersons.[].name`	String	用户名称
`contactPersons.[].nameEn`	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
`contactPersons.[].mobile`	String	用户手机号
`contactPersons.[].email`	String	用户邮箱
`contactPersons.[].position`	String	职位
`contactPersons.[].contactRoles`	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
`bankAccounts`	Object[]	银行账户列表，支持多个账户
`bankAccounts.[].accountName`	String	开户名称
`bankAccounts.[].bankName`	String	银行名称
`bankAccounts.[].bankCode`	String	联行号
`bankAccounts.[].bankAccount`	String	银行账号
`bankAccounts.[].currency`	String	币制 CNY - 人民币 USD - 美元 EUR - 欧元 HKD - 港币 JPY - 日元 GBP - 英镑 AUD - 澳大利亚元 CAD - 加拿大元 SGD - 新加坡元 KRW - 韩元 DKK - 丹麦克朗 NOK - 挪威克朗 SEK - 瑞典克朗 name - 获取币种名称 symbol - 获取币种符号 code - 返回币种代码
`bankAccounts.[].swiftCode`	String	SWIFT CODE
`bankAccounts.[].address`	String	地址
`bankAccounts.[].isDefault`	Boolean	是否默认
`invoiceInfo`	Object	开票信息
`invoiceInfo.companyName`	String	公司名称
`invoiceInfo.taxIdentificationNumber`	String	纳税识别号
`invoiceInfo.companyAddress`	String	公司地址
`invoiceInfo.phone`	String	电话
`invoiceInfo.bankAccount`	String	银行账号
`invoiceInfo.contact`	String	联系人
`invoiceInfo.email`	String	邮箱
`remarks`	String	备注信息
`legalEntityId`	String	法人主体id
`extraProps`	Object	扩展属性
`crBy`	String	创建者
`upBy`	String	最后修改者
`crDate`	String	创建时间
`upDate`	String	最后修改时间
`tenantId`	String	租户ID
`id`	Varies	获取客户唯一标识

下载结果模型定义

请求​

请求参数​

返回​

返回属性​

请求

请求参数

返回

返回属性