跳到主要内容

cs.contracts.create

创建合约

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

请求​

RSocket.rr({
"route" : "cs.contracts.create",
"data" : {
"replaceMe" : "合约对象"
}
});

请求参数​

名称类型必须说明
contractIdString否合约系统唯一标识,用于持久化定位及下游稳定关联。
contractNoString否合约号(约号),作为租户内唯一的可编辑业务编号。
auditInfoObject否审核信息
auditInfo.auditStatusString否审核状态
  • PENDING - 待审核
  • APPROVED - 已审核
  • REJECTED - 已驳回
  • auditInfo.approvalReasonString否通过理由
    auditInfo.rejectionReasonString否拒绝理由
    auditInfo.auditTimeString否审核时间
    auditInfo.auditorObject否审核人
    auditInfo.auditor.usernameString否用户标识
    auditInfo.auditor.nameString否用户名称
    auditInfo.auditor.nameEnString否英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    auditInfo.auditor.mobileString否用户手机号
    auditInfo.auditor.emailString否用户邮箱
    auditInfo.auditor.positionString否职位
    auditInfo.auditor.contactRolesString[]否联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • contractNatureIdString否约价性质(基础数据id)
    routesString[]否航线列表(基础数据id集合)
    contractTypeString否合约类型(基础数据id)
    limitInfosObject[]否限定信息
    limitInfos.[].shipperString否发货人信息(往来单位id)
    limitInfos.[].consigneeString否收货人(往来单位id)
    limitInfos.[].cargoNameString否品名
    carrierString否船公司(往来单位id)
    cargoIdString否货品类型(基础数据id)
    mqcNumber否最低运输箱量承诺
    isSpaceProtectedBoolean否是否舱保 (舱位保护)
    protectionQtyNumber否舱保数量
    protectionUnitIdString否舱保单位(基础数据id)
    validFromString否有效期起
    validToString否有效期止
    remarkString否备注
    attachmentsObject[]否附件列表
    attachments.[].titleString否附件标题
    attachments.[].descriptionString否附件说明
    attachments.[].binaryIdString[]否附件id
    freeTimeDetNumber否免堆期 (天)
    legalEntityIdString否法人主体id
    customerIdString否客户id
    extraPropsObject否扩展属性
    crByString否创建者
    upByString否最后修改者
    crDateString否创建时间
    upDateString否最后修改时间
    idVaries否

    返回​

    创建后的合约对象

    { }

    返回属性​

    名称类型说明
    contractIdString合约系统唯一标识,用于持久化定位及下游稳定关联。
    contractNoString合约号(约号),作为租户内唯一的可编辑业务编号。
    auditInfoObject审核信息
    auditInfo.auditStatusString审核状态
  • PENDING - 待审核
  • APPROVED - 已审核
  • REJECTED - 已驳回
  • auditInfo.approvalReasonString通过理由
    auditInfo.rejectionReasonString拒绝理由
    auditInfo.auditTimeString审核时间
    auditInfo.auditorObject审核人
    auditInfo.auditor.usernameString用户标识
    auditInfo.auditor.nameString用户名称
    auditInfo.auditor.nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    auditInfo.auditor.mobileString用户手机号
    auditInfo.auditor.emailString用户邮箱
    auditInfo.auditor.positionString职位
    auditInfo.auditor.contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • contractNatureIdString约价性质(基础数据id)
    contractNatureObject约价性质(基础数据)
    contractNature.itemIdString数据项唯一标识
    contractNature.nameString数据项名称(中文)
    contractNature.nameEnString数据项名称(英文)
    contractNature.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    routesString[]航线列表(基础数据id集合)
    routeInfosObject[]航线列表
    routeInfos.[].itemIdString数据项唯一标识
    routeInfos.[].nameString数据项名称(中文)
    routeInfos.[].nameEnString数据项名称(英文)
    routeInfos.[].extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    contractTypeString合约类型(基础数据id)
    contractTypeInfoObject合约类型信息
    contractTypeInfo.itemIdString数据项唯一标识
    contractTypeInfo.nameString数据项名称(中文)
    contractTypeInfo.nameEnString数据项名称(英文)
    contractTypeInfo.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    limitInfosObject[]限定信息
    limitInfos.[].shipperString发货人信息(往来单位id)
    limitInfos.[].shipperInfoObject发货人信息
    limitInfos.[].shipperInfo.countryString国家
    limitInfos.[].shipperInfo.countryEnString国家(英文)
    limitInfos.[].shipperInfo.abbreviationString名称缩写
    limitInfos.[].shipperInfo.addressString地址(中文)
    limitInfos.[].shipperInfo.addressEnString地址(英文)
    limitInfos.[].shipperInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    limitInfos.[].shipperInfo.contactPersons.[].usernameString用户标识
    limitInfos.[].shipperInfo.contactPersons.[].nameString用户名称
    limitInfos.[].shipperInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    limitInfos.[].shipperInfo.contactPersons.[].mobileString用户手机号
    limitInfos.[].shipperInfo.contactPersons.[].emailString用户邮箱
    limitInfos.[].shipperInfo.contactPersons.[].positionString职位
    limitInfos.[].shipperInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • limitInfos.[].shipperInfo.bankAccountsObject[]银行账户列表,支持多个账户
    limitInfos.[].shipperInfo.bankAccounts.[].accountNameString开户名称
    limitInfos.[].shipperInfo.bankAccounts.[].bankNameString银行名称
    limitInfos.[].shipperInfo.bankAccounts.[].bankCodeString联行号
    limitInfos.[].shipperInfo.bankAccounts.[].bankAccountString银行账号
    limitInfos.[].shipperInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • limitInfos.[].shipperInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    limitInfos.[].shipperInfo.bankAccounts.[].addressString地址
    limitInfos.[].shipperInfo.bankAccounts.[].isDefaultBoolean是否默认
    limitInfos.[].shipperInfo.invoiceInfoObject开票信息
    limitInfos.[].shipperInfo.invoiceInfo.companyNameString公司名称
    limitInfos.[].shipperInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    limitInfos.[].shipperInfo.invoiceInfo.companyAddressString公司地址
    limitInfos.[].shipperInfo.invoiceInfo.phoneString电话
    limitInfos.[].shipperInfo.invoiceInfo.bankAccountString银行账号
    limitInfos.[].shipperInfo.invoiceInfo.contactString联系人
    limitInfos.[].shipperInfo.invoiceInfo.emailString邮箱
    limitInfos.[].shipperInfo.extraPropsObject扩展信息
    limitInfos.[].shipperInfo.relatedCustomersObject[]关联客户列表
    limitInfos.[].shipperInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    limitInfos.[].shipperInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    limitInfos.[].shipperInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    limitInfos.[].shipperInfo.relatedCustomers.[].nameString名称(中文)
    limitInfos.[].shipperInfo.relatedCustomers.[].nameEnString名称(英文)
    limitInfos.[].shipperInfo.unitIdString往来单位唯一ID,主键
    limitInfos.[].shipperInfo.nameString名称(中文)
    limitInfos.[].shipperInfo.nameEnString名称(英文)
    limitInfos.[].consigneeString收货人(往来单位id)
    limitInfos.[].consigneeInfoObject收货人信息
    limitInfos.[].consigneeInfo.countryString国家
    limitInfos.[].consigneeInfo.countryEnString国家(英文)
    limitInfos.[].consigneeInfo.abbreviationString名称缩写
    limitInfos.[].consigneeInfo.addressString地址(中文)
    limitInfos.[].consigneeInfo.addressEnString地址(英文)
    limitInfos.[].consigneeInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    limitInfos.[].consigneeInfo.contactPersons.[].usernameString用户标识
    limitInfos.[].consigneeInfo.contactPersons.[].nameString用户名称
    limitInfos.[].consigneeInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    limitInfos.[].consigneeInfo.contactPersons.[].mobileString用户手机号
    limitInfos.[].consigneeInfo.contactPersons.[].emailString用户邮箱
    limitInfos.[].consigneeInfo.contactPersons.[].positionString职位
    limitInfos.[].consigneeInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • limitInfos.[].consigneeInfo.bankAccountsObject[]银行账户列表,支持多个账户
    limitInfos.[].consigneeInfo.bankAccounts.[].accountNameString开户名称
    limitInfos.[].consigneeInfo.bankAccounts.[].bankNameString银行名称
    limitInfos.[].consigneeInfo.bankAccounts.[].bankCodeString联行号
    limitInfos.[].consigneeInfo.bankAccounts.[].bankAccountString银行账号
    limitInfos.[].consigneeInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • limitInfos.[].consigneeInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    limitInfos.[].consigneeInfo.bankAccounts.[].addressString地址
    limitInfos.[].consigneeInfo.bankAccounts.[].isDefaultBoolean是否默认
    limitInfos.[].consigneeInfo.invoiceInfoObject开票信息
    limitInfos.[].consigneeInfo.invoiceInfo.companyNameString公司名称
    limitInfos.[].consigneeInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    limitInfos.[].consigneeInfo.invoiceInfo.companyAddressString公司地址
    limitInfos.[].consigneeInfo.invoiceInfo.phoneString电话
    limitInfos.[].consigneeInfo.invoiceInfo.bankAccountString银行账号
    limitInfos.[].consigneeInfo.invoiceInfo.contactString联系人
    limitInfos.[].consigneeInfo.invoiceInfo.emailString邮箱
    limitInfos.[].consigneeInfo.extraPropsObject扩展信息
    limitInfos.[].consigneeInfo.relatedCustomersObject[]关联客户列表
    limitInfos.[].consigneeInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    limitInfos.[].consigneeInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    limitInfos.[].consigneeInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    limitInfos.[].consigneeInfo.relatedCustomers.[].nameString名称(中文)
    limitInfos.[].consigneeInfo.relatedCustomers.[].nameEnString名称(英文)
    limitInfos.[].consigneeInfo.unitIdString往来单位唯一ID,主键
    limitInfos.[].consigneeInfo.nameString名称(中文)
    limitInfos.[].consigneeInfo.nameEnString名称(英文)
    limitInfos.[].cargoNameString品名
    carrierString船公司(往来单位id)
    carrierInfoObject船公司信息
    carrierInfo.countryString国家
    carrierInfo.countryEnString国家(英文)
    carrierInfo.abbreviationString名称缩写
    carrierInfo.addressString地址(中文)
    carrierInfo.addressEnString地址(英文)
    carrierInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    carrierInfo.contactPersons.[].usernameString用户标识
    carrierInfo.contactPersons.[].nameString用户名称
    carrierInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    carrierInfo.contactPersons.[].mobileString用户手机号
    carrierInfo.contactPersons.[].emailString用户邮箱
    carrierInfo.contactPersons.[].positionString职位
    carrierInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • carrierInfo.bankAccountsObject[]银行账户列表,支持多个账户
    carrierInfo.bankAccounts.[].accountNameString开户名称
    carrierInfo.bankAccounts.[].bankNameString银行名称
    carrierInfo.bankAccounts.[].bankCodeString联行号
    carrierInfo.bankAccounts.[].bankAccountString银行账号
    carrierInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • carrierInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    carrierInfo.bankAccounts.[].addressString地址
    carrierInfo.bankAccounts.[].isDefaultBoolean是否默认
    carrierInfo.invoiceInfoObject开票信息
    carrierInfo.invoiceInfo.companyNameString公司名称
    carrierInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    carrierInfo.invoiceInfo.companyAddressString公司地址
    carrierInfo.invoiceInfo.phoneString电话
    carrierInfo.invoiceInfo.bankAccountString银行账号
    carrierInfo.invoiceInfo.contactString联系人
    carrierInfo.invoiceInfo.emailString邮箱
    carrierInfo.extraPropsObject扩展信息
    carrierInfo.relatedCustomersObject[]关联客户列表
    carrierInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    carrierInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    carrierInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    carrierInfo.relatedCustomers.[].nameString名称(中文)
    carrierInfo.relatedCustomers.[].nameEnString名称(英文)
    carrierInfo.unitIdString往来单位唯一ID,主键
    carrierInfo.nameString名称(中文)
    carrierInfo.nameEnString名称(英文)
    cargoIdString货品类型(基础数据id)
    cargoObject货品类型(基础数据)
    cargo.itemIdString数据项唯一标识
    cargo.nameString数据项名称(中文)
    cargo.nameEnString数据项名称(英文)
    cargo.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    mqcNumber最低运输箱量承诺
    isSpaceProtectedBoolean是否舱保 (舱位保护)
    protectionQtyNumber舱保数量
    protectionUnitIdString舱保单位(基础数据id)
    protectionUnitObject舱保单位(基础数据)
    protectionUnit.itemIdString数据项唯一标识
    protectionUnit.nameString数据项名称(中文)
    protectionUnit.nameEnString数据项名称(英文)
    protectionUnit.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    validFromString有效期起
    validToString有效期止
    remarkString备注
    attachmentsObject[]附件列表
    attachments.[].titleString附件标题
    attachments.[].descriptionString附件说明
    attachments.[].binaryIdString[]附件id
    freeTimeDetNumber免堆期 (天)
    legalEntityIdString法人主体id
    customerIdString客户id
    extraPropsObject扩展属性
    crByString创建者
    upByString最后修改者
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID
    idVaries

    下载结果模型定义