cs.contracts.list

分页查询合约列表

• 请求路由: cs.contracts.list
• 交互模型: Request Stream
• 访问限制: 无

请求

RSocket.rs({
  "route" : "cs.contracts.list",
  "args" : {
    "search" : "搜索参数",
    "pg" : "分页参数"
  }
});

请求参数

名称	类型	必须	说明
search	Object	否	搜索参数
search.contractNo	String	否	合约号
search.contractNature	String	否	约价性质
search.carrierId	String	否	船公司 ID
search.isSpaceProtected	Boolean	否	是否舱保
search.auditStatus	String	否	审批状态 PENDING - 待审核 APPROVED - 已审核 REJECTED - 已驳回
search.validityStart	String	否	有效期起
search.validityEnd	String	否	有效期止
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"]

返回

合约列表

[ ]

返回属性

名称	类型	说明
contractId	String	合约系统唯一标识，用于持久化定位及下游稳定关联。
contractNo	String	合约号（约号），作为租户内唯一的可编辑业务编号。
auditInfo	Object	审核信息
auditInfo.auditStatus	String	审核状态 PENDING - 待审核 APPROVED - 已审核 REJECTED - 已驳回
auditInfo.approvalReason	String	通过理由
auditInfo.rejectionReason	String	拒绝理由
auditInfo.auditTime	String	审核时间
auditInfo.auditor	Object	审核人
auditInfo.auditor.username	String	用户标识
auditInfo.auditor.name	String	用户名称
auditInfo.auditor.nameEn	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
auditInfo.auditor.mobile	String	用户手机号
auditInfo.auditor.email	String	用户邮箱
auditInfo.auditor.position	String	职位
auditInfo.auditor.contactRoles	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
contractNatureId	String	约价性质（基础数据id）
contractNature	Object	约价性质（基础数据）
contractNature.itemId	String	数据项唯一标识
contractNature.name	String	数据项名称（中文）
contractNature.nameEn	String	数据项名称（英文）
contractNature.extendedProperties	Object	扩展属性 用于存储一些额外的、非结构化的数据
routes	String[]	航线列表（基础数据id集合）
routeInfos	Object[]	航线列表
routeInfos.[].itemId	String	数据项唯一标识
routeInfos.[].name	String	数据项名称（中文）
routeInfos.[].nameEn	String	数据项名称（英文）
routeInfos.[].extendedProperties	Object	扩展属性 用于存储一些额外的、非结构化的数据
contractType	String	合约类型(基础数据id)
contractTypeInfo	Object	合约类型信息
contractTypeInfo.itemId	String	数据项唯一标识
contractTypeInfo.name	String	数据项名称（中文）
contractTypeInfo.nameEn	String	数据项名称（英文）
contractTypeInfo.extendedProperties	Object	扩展属性 用于存储一些额外的、非结构化的数据
limitInfos	Object[]	限定信息
limitInfos.[].shipper	String	发货人信息（往来单位id）
limitInfos.[].shipperInfo	Object	发货人信息
limitInfos.[].shipperInfo.country	String	国家
limitInfos.[].shipperInfo.countryEn	String	国家(英文)
limitInfos.[].shipperInfo.abbreviation	String	名称缩写
limitInfos.[].shipperInfo.address	String	地址（中文）
limitInfos.[].shipperInfo.addressEn	String	地址（英文）
limitInfos.[].shipperInfo.contactPersons	Object[]	联系人信息列表，支持多个联系人
limitInfos.[].shipperInfo.contactPersons.[].username	String	用户标识
limitInfos.[].shipperInfo.contactPersons.[].name	String	用户名称
limitInfos.[].shipperInfo.contactPersons.[].nameEn	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
limitInfos.[].shipperInfo.contactPersons.[].mobile	String	用户手机号
limitInfos.[].shipperInfo.contactPersons.[].email	String	用户邮箱
limitInfos.[].shipperInfo.contactPersons.[].position	String	职位
limitInfos.[].shipperInfo.contactPersons.[].contactRoles	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
limitInfos.[].shipperInfo.bankAccounts	Object[]	银行账户列表，支持多个账户
limitInfos.[].shipperInfo.bankAccounts.[].accountName	String	开户名称
limitInfos.[].shipperInfo.bankAccounts.[].bankName	String	银行名称
limitInfos.[].shipperInfo.bankAccounts.[].bankCode	String	联行号
limitInfos.[].shipperInfo.bankAccounts.[].bankAccount	String	银行账号
limitInfos.[].shipperInfo.bankAccounts.[].currency	String	币制 CNY - 人民币 USD - 美元 EUR - 欧元 HKD - 港币 JPY - 日元 GBP - 英镑 AUD - 澳大利亚元 CAD - 加拿大元 SGD - 新加坡元 KRW - 韩元 DKK - 丹麦克朗 NOK - 挪威克朗 SEK - 瑞典克朗 name - 获取币种名称 symbol - 获取币种符号 code - 返回币种代码
limitInfos.[].shipperInfo.bankAccounts.[].swiftCode	String	SWIFT CODE
limitInfos.[].shipperInfo.bankAccounts.[].address	String	地址
limitInfos.[].shipperInfo.bankAccounts.[].isDefault	Boolean	是否默认
limitInfos.[].shipperInfo.invoiceInfo	Object	开票信息
limitInfos.[].shipperInfo.invoiceInfo.companyName	String	公司名称
limitInfos.[].shipperInfo.invoiceInfo.taxIdentificationNumber	String	纳税识别号
limitInfos.[].shipperInfo.invoiceInfo.companyAddress	String	公司地址
limitInfos.[].shipperInfo.invoiceInfo.phone	String	电话
limitInfos.[].shipperInfo.invoiceInfo.bankAccount	String	银行账号
limitInfos.[].shipperInfo.invoiceInfo.contact	String	联系人
limitInfos.[].shipperInfo.invoiceInfo.email	String	邮箱
limitInfos.[].shipperInfo.extraProps	Object	扩展信息
limitInfos.[].shipperInfo.relatedCustomers	Object[]	关联客户列表
limitInfos.[].shipperInfo.relatedCustomers.[].tags	String[]	该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
limitInfos.[].shipperInfo.relatedCustomers.[].extraProps	Object	专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
limitInfos.[].shipperInfo.relatedCustomers.[].unitId	String	往来单位唯一ID，主键
limitInfos.[].shipperInfo.relatedCustomers.[].name	String	名称（中文）
limitInfos.[].shipperInfo.relatedCustomers.[].nameEn	String	名称（英文）
limitInfos.[].shipperInfo.unitId	String	往来单位唯一ID，主键
limitInfos.[].shipperInfo.name	String	名称（中文）
limitInfos.[].shipperInfo.nameEn	String	名称（英文）
limitInfos.[].consignee	String	收货人（往来单位id）
limitInfos.[].consigneeInfo	Object	收货人信息
limitInfos.[].consigneeInfo.country	String	国家
limitInfos.[].consigneeInfo.countryEn	String	国家(英文)
limitInfos.[].consigneeInfo.abbreviation	String	名称缩写
limitInfos.[].consigneeInfo.address	String	地址（中文）
limitInfos.[].consigneeInfo.addressEn	String	地址（英文）
limitInfos.[].consigneeInfo.contactPersons	Object[]	联系人信息列表，支持多个联系人
limitInfos.[].consigneeInfo.contactPersons.[].username	String	用户标识
limitInfos.[].consigneeInfo.contactPersons.[].name	String	用户名称
limitInfos.[].consigneeInfo.contactPersons.[].nameEn	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
limitInfos.[].consigneeInfo.contactPersons.[].mobile	String	用户手机号
limitInfos.[].consigneeInfo.contactPersons.[].email	String	用户邮箱
limitInfos.[].consigneeInfo.contactPersons.[].position	String	职位
limitInfos.[].consigneeInfo.contactPersons.[].contactRoles	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
limitInfos.[].consigneeInfo.bankAccounts	Object[]	银行账户列表，支持多个账户
limitInfos.[].consigneeInfo.bankAccounts.[].accountName	String	开户名称
limitInfos.[].consigneeInfo.bankAccounts.[].bankName	String	银行名称
limitInfos.[].consigneeInfo.bankAccounts.[].bankCode	String	联行号
limitInfos.[].consigneeInfo.bankAccounts.[].bankAccount	String	银行账号
limitInfos.[].consigneeInfo.bankAccounts.[].currency	String	币制 CNY - 人民币 USD - 美元 EUR - 欧元 HKD - 港币 JPY - 日元 GBP - 英镑 AUD - 澳大利亚元 CAD - 加拿大元 SGD - 新加坡元 KRW - 韩元 DKK - 丹麦克朗 NOK - 挪威克朗 SEK - 瑞典克朗 name - 获取币种名称 symbol - 获取币种符号 code - 返回币种代码
limitInfos.[].consigneeInfo.bankAccounts.[].swiftCode	String	SWIFT CODE
limitInfos.[].consigneeInfo.bankAccounts.[].address	String	地址
limitInfos.[].consigneeInfo.bankAccounts.[].isDefault	Boolean	是否默认
limitInfos.[].consigneeInfo.invoiceInfo	Object	开票信息
limitInfos.[].consigneeInfo.invoiceInfo.companyName	String	公司名称
limitInfos.[].consigneeInfo.invoiceInfo.taxIdentificationNumber	String	纳税识别号
limitInfos.[].consigneeInfo.invoiceInfo.companyAddress	String	公司地址
limitInfos.[].consigneeInfo.invoiceInfo.phone	String	电话
limitInfos.[].consigneeInfo.invoiceInfo.bankAccount	String	银行账号
limitInfos.[].consigneeInfo.invoiceInfo.contact	String	联系人
limitInfos.[].consigneeInfo.invoiceInfo.email	String	邮箱
limitInfos.[].consigneeInfo.extraProps	Object	扩展信息
limitInfos.[].consigneeInfo.relatedCustomers	Object[]	关联客户列表
limitInfos.[].consigneeInfo.relatedCustomers.[].tags	String[]	该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
limitInfos.[].consigneeInfo.relatedCustomers.[].extraProps	Object	专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
limitInfos.[].consigneeInfo.relatedCustomers.[].unitId	String	往来单位唯一ID，主键
limitInfos.[].consigneeInfo.relatedCustomers.[].name	String	名称（中文）
limitInfos.[].consigneeInfo.relatedCustomers.[].nameEn	String	名称（英文）
limitInfos.[].consigneeInfo.unitId	String	往来单位唯一ID，主键
limitInfos.[].consigneeInfo.name	String	名称（中文）
limitInfos.[].consigneeInfo.nameEn	String	名称（英文）
limitInfos.[].cargoName	String	品名
carrier	String	船公司(往来单位id)
carrierInfo	Object	船公司信息
carrierInfo.country	String	国家
carrierInfo.countryEn	String	国家(英文)
carrierInfo.abbreviation	String	名称缩写
carrierInfo.address	String	地址（中文）
carrierInfo.addressEn	String	地址（英文）
carrierInfo.contactPersons	Object[]	联系人信息列表，支持多个联系人
carrierInfo.contactPersons.[].username	String	用户标识
carrierInfo.contactPersons.[].name	String	用户名称
carrierInfo.contactPersons.[].nameEn	String	英文称呼，用于外部联系人的英文通知；缺失时不自动翻译姓名。
carrierInfo.contactPersons.[].mobile	String	用户手机号
carrierInfo.contactPersons.[].email	String	用户邮箱
carrierInfo.contactPersons.[].position	String	职位
carrierInfo.contactPersons.[].contactRoles	String[]	联系人承担的职责，支持多选；未指定时为空集合 PRIMARY - 主联系人，承担往来单位的主要业务对接职责。 EMAIL_NOTIFICATION - 邮件通知人，作为业务邮件通知的联系对象。 BILLING - 账单联系人，承担账单接收和账务沟通职责。
carrierInfo.bankAccounts	Object[]	银行账户列表，支持多个账户
carrierInfo.bankAccounts.[].accountName	String	开户名称
carrierInfo.bankAccounts.[].bankName	String	银行名称
carrierInfo.bankAccounts.[].bankCode	String	联行号
carrierInfo.bankAccounts.[].bankAccount	String	银行账号
carrierInfo.bankAccounts.[].currency	String	币制 CNY - 人民币 USD - 美元 EUR - 欧元 HKD - 港币 JPY - 日元 GBP - 英镑 AUD - 澳大利亚元 CAD - 加拿大元 SGD - 新加坡元 KRW - 韩元 DKK - 丹麦克朗 NOK - 挪威克朗 SEK - 瑞典克朗 name - 获取币种名称 symbol - 获取币种符号 code - 返回币种代码
carrierInfo.bankAccounts.[].swiftCode	String	SWIFT CODE
carrierInfo.bankAccounts.[].address	String	地址
carrierInfo.bankAccounts.[].isDefault	Boolean	是否默认
carrierInfo.invoiceInfo	Object	开票信息
carrierInfo.invoiceInfo.companyName	String	公司名称
carrierInfo.invoiceInfo.taxIdentificationNumber	String	纳税识别号
carrierInfo.invoiceInfo.companyAddress	String	公司地址
carrierInfo.invoiceInfo.phone	String	电话
carrierInfo.invoiceInfo.bankAccount	String	银行账号
carrierInfo.invoiceInfo.contact	String	联系人
carrierInfo.invoiceInfo.email	String	邮箱
carrierInfo.extraProps	Object	扩展信息
carrierInfo.relatedCustomers	Object[]	关联客户列表
carrierInfo.relatedCustomers.[].tags	String[]	该客户赋予当前往来单位的角色标签列表（如 shipper, consignee, importBuyer 等）
carrierInfo.relatedCustomers.[].extraProps	Object	专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
carrierInfo.relatedCustomers.[].unitId	String	往来单位唯一ID，主键
carrierInfo.relatedCustomers.[].name	String	名称（中文）
carrierInfo.relatedCustomers.[].nameEn	String	名称（英文）
carrierInfo.unitId	String	往来单位唯一ID，主键
carrierInfo.name	String	名称（中文）
carrierInfo.nameEn	String	名称（英文）
cargoId	String	货品类型（基础数据id）
cargo	Object	货品类型（基础数据）
cargo.itemId	String	数据项唯一标识
cargo.name	String	数据项名称（中文）
cargo.nameEn	String	数据项名称（英文）
cargo.extendedProperties	Object	扩展属性 用于存储一些额外的、非结构化的数据
mqc	Number	最低运输箱量承诺
isSpaceProtected	Boolean	是否舱保 (舱位保护)
protectionQty	Number	舱保数量
protectionUnitId	String	舱保单位（基础数据id）
protectionUnit	Object	舱保单位（基础数据）
protectionUnit.itemId	String	数据项唯一标识
protectionUnit.name	String	数据项名称（中文）
protectionUnit.nameEn	String	数据项名称（英文）
protectionUnit.extendedProperties	Object	扩展属性 用于存储一些额外的、非结构化的数据
validFrom	String	有效期起
validTo	String	有效期止
remark	String	备注
attachments	Object[]	附件列表
attachments.[].title	String	附件标题
attachments.[].description	String	附件说明
attachments.[].binaryId	String[]	附件id
freeTimeDet	Number	免堆期 (天)
legalEntityId	String	法人主体id
customerId	String	客户id
extraProps	Object	扩展属性
crBy	String	创建者
upBy	String	最后修改者
crDate	String	创建时间
upDate	String	最后修改时间
tenantId	String	租户ID
id	Varies

下载结果模型定义