cs.units.consignees.list

查询当前用户主体范围内的收货人，按字典决定是否必须指定关联客户。

请求路由: cs.units.consignees.list

交互模型: Request Stream

访问限制: 无

请求

RSocket.rs({
  "route" : "cs.units.consignees.list",
  "args" : {
    "search" : "搜索条件；后端固定收货人角色及主体范围",
    "pg" : "分页和排序信息"
  }
});

请求参数

名称	类型	必须	说明
`search`	Object	否	搜索条件；后端固定收货人角色及主体范围
`search.status`	String	否	状态 NORMAL - 正常 DISABLED - 禁用
`search.unitIds`	String[]	否	需要匹配的往来单位ID集合
`search.tags`	String[]	否	标签列表，用于分类或标记
`search.contactPersonMobile`	String	否	联系人手机号
`search.needNullData`	Boolean	否	是否需要空数据和relatedCustomerIds搭配使用,当relatedCustomerIds有值时 needNullData=true表示需要查询关联客户id列表为空的数据 needNullData=false表示不需要查询关联客户id列表为空的数据
`search.relatedCustomerIds`	String[]	否	关联客户id列表
`search.countries`	String[]	否	国家多选过滤列表 (对应 country 属性，如 ["US", "CN"])
`search.cityNames`	String[]	否	城市多选过滤列表 (对应 extraProps.dock.cityName 属性)
`search.routeNames`	String[]	否	航线多选过滤列表 (对应 extraProps.dock.tags 属性，模糊匹配 "RT:航线")
`search.isPublic`	Boolean	否	是否公开
`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"]

满足主体、客户关联或公开资料条件的收货人

[ ]

返回属性

名称	类型	说明
`unitId`	String	往来单位唯一ID，主键
`status`	String	状态 NORMAL - 正常 DISABLED - 禁用
`name`	String	名称（中文）
`nameEn`	String	名称（英文）
`abbreviation`	String	名称缩写
`country`	String	国家
`countryEn`	String	国家(英文)
`tags`	String[]	标签列表，用于分类或标记
`address`	String	地址（中文）
`addressEn`	String	地址（英文）
`contactPersons`	Object[]	联系人信息列表，支持多个联系人
`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	邮箱
`relatedCustomers`	Object[]	关联客户列表
`relatedCustomers.[].tags`	String[]	该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
`relatedCustomers.[].extraProps`	Object	专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
`relatedCustomers.[].unitId`	String	往来单位唯一ID，主键
`relatedCustomers.[].name`	String	名称（中文）
`relatedCustomers.[].nameEn`	String	名称（英文）
`sortWeight`	Number	排序权重
`isPublic`	Boolean	是否公开
`legalEntityId`	String	法人主体id
`customerId`	String	客户id
`extraProps`	Object	扩展属性
`crBy`	String	创建者
`upBy`	String	最后修改者
`crDate`	String	创建时间
`upDate`	String	最后修改时间
`tenantId`	String	租户ID
`id`	Varies
`dockProps`	Object	获取 dock 扩展属性（港口专属信息）当 tags 含 "dock" 时此字段才有意义
`dockTimeZone`	String	获取港口所在时区（如 "Asia/Shanghai"）用于把第三方 API 返回的港口当地时间（无时区）转 UTC Instant

下载结果模型定义

请求​

请求参数​

返回​

返回属性​

请求

请求参数

返回

返回属性