跳到主要内容

cs.crm.customers.create

新增客户

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

请求​

RSocket.rr({
"route" : "cs.crm.customers.create",
"data" : {
"replaceMe" : "待创建的客户实体对象"
}
});

请求参数​

名称类型必须说明
customerIdString否客户 ID,对应往来单位的 unitId
unifiedSocialCreditCodeString否统一社会信用代码
companyEmailString否公司邮箱
companyPhoneString否公司电话
companyWebsiteString否公司网址
registerYearsNumber否注册年限
mainBusinessString否主营业务
cargoTypesString[]否主要货源类型列表
sourceChannelString否来源渠道(基础数据id)
sourceDetailString否来源详情
levelString否客户等级(基础数据id)
salespersonsObject[]否平等归属的销售人员;空列表表示客户没有销售归属。
salespersons.[].departmentString否部门id
salespersons.[].departmentNameString否部门名称
salespersons.[].usernameString否用户标识
salespersons.[].nameString否用户名称
salespersons.[].nameEnString否英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
salespersons.[].mobileString否用户手机号
salespersons.[].emailString否用户邮箱
salespersons.[].positionString否职位
salespersons.[].contactRolesString[]否联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • operatorsObject[]否负责该客户的操作人员;按用户名识别,空列表表示尚未分配。
    操作人员可在所属租户及获准法人主体范围内查看客户,与销售归属及公海状态独立。
    operators.[].usernameString否用户标识
    operators.[].nameString否用户名称
    operators.[].nameEnString否英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    operators.[].mobileString否用户手机号
    operators.[].emailString否用户邮箱
    operators.[].positionString否职位
    operators.[].contactRolesString[]否联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • tagsString[]否客户标签
    mainRoutesString[]否主要航线(基础数据id列表)
    totalTeuNumber否累计箱量 (TEU)
    lastShipmentDateString否最近走货日期(UTC)
    lastFollowUpDateString否最近跟进日期(UTC)
    isPublicBoolean否是否处于公海
    publicEnterTimeString否进入公海时间(UTC)
    ownerAssignTimeString否销售分配时间(UTC)
    followUpStatusString否跟进状态
  • NORMAL - 正常
  • OVERDUE - 超期未跟进
  • isFirstOrderBoolean否是否首次下单
    businessInfoObject否商务信息
    businessInfo.settlementModeString否结算方式
  • SPOT - 票结/见款放单(账期 0 天)
  • MONTHLY - 月结
  • CUSTOM - 自定义账期
  • businessInfo.creditDaysNumber否账期(天)
    attachmentsObject[]否客户附件
    attachments.[].titleString否附件标题
    attachments.[].descriptionString否附件说明
    attachments.[].binaryIdString[]否附件id
    statusString否状态
  • NORMAL - 正常
  • DISABLED - 禁用
  • nameString否往来单位中文名(公共字段,与 Unit 同步保存)
    nameEnString否往来单位英文名(公共字段,与 Unit 同步保存)
    abbreviationString否往来单位简称(公共字段,与 Unit 同步保存)
    countryString否往来单位所在国家/地区(公共字段,与 Unit 同步保存)
    countryEnString否往来单位所在国家/地区英文名(公共字段,与 Unit 同步保存)
    addressString否往来单位中文地址(公共字段,与 Unit 同步保存)
    addressEnString否往来单位英文地址(公共字段,与 Unit 同步保存)
    contactPersonsObject[]否联系人列表(公共字段,与 Unit 同步保存)
    contactPersons.[].usernameString否用户标识
    contactPersons.[].nameString否用户名称
    contactPersons.[].nameEnString否英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    contactPersons.[].mobileString否用户手机号
    contactPersons.[].emailString否用户邮箱
    contactPersons.[].positionString否职位
    contactPersons.[].contactRolesString[]否联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • bankAccountsObject[]否银行账户列表,支持多个账户
    bankAccounts.[].accountNameString否开户名称
    bankAccounts.[].bankNameString否银行名称
    bankAccounts.[].bankCodeString否联行号
    bankAccounts.[].bankAccountString否银行账号
    bankAccounts.[].currencyString否币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • bankAccounts.[].swiftCodeString否SWIFT CODE
    bankAccounts.[].addressString否地址
    bankAccounts.[].isDefaultBoolean否是否默认
    invoiceInfoObject否开票信息
    invoiceInfo.companyNameString否公司名称
    invoiceInfo.taxIdentificationNumberString否纳税识别号
    invoiceInfo.companyAddressString否公司地址
    invoiceInfo.phoneString否电话
    invoiceInfo.bankAccountString否银行账号
    invoiceInfo.contactString否联系人
    invoiceInfo.emailString否邮箱
    remarksString否备注信息
    legalEntityIdString否法人主体id
    extraPropsObject否扩展属性
    crByString否创建者
    upByString否最后修改者
    crDateString否创建时间
    upDateString否最后修改时间
    idVaries否获取客户唯一标识

    返回​

    新增后的客户实体对象 Mono 包装

    { }

    返回属性​

    名称类型说明
    customerIdString客户 ID,对应往来单位的 unitId
    unifiedSocialCreditCodeString统一社会信用代码
    companyEmailString公司邮箱
    companyPhoneString公司电话
    companyWebsiteString公司网址
    registerYearsNumber注册年限
    mainBusinessString主营业务
    cargoTypesString[]主要货源类型列表
    sourceChannelString来源渠道(基础数据id)
    sourceChannelInfoObject来源渠道信息
    sourceChannelInfo.itemIdString数据项唯一标识
    sourceChannelInfo.nameString数据项名称(中文)
    sourceChannelInfo.nameEnString数据项名称(英文)
    sourceChannelInfo.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    sourceDetailString来源详情
    levelString客户等级(基础数据id)
    levelInfoObject客户等级信息
    levelInfo.itemIdString数据项唯一标识
    levelInfo.nameString数据项名称(中文)
    levelInfo.nameEnString数据项名称(英文)
    levelInfo.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    salespersonsObject[]平等归属的销售人员;空列表表示客户没有销售归属。
    salespersons.[].departmentString部门id
    salespersons.[].departmentNameString部门名称
    salespersons.[].usernameString用户标识
    salespersons.[].nameString用户名称
    salespersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    salespersons.[].mobileString用户手机号
    salespersons.[].emailString用户邮箱
    salespersons.[].positionString职位
    salespersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • operatorsObject[]负责该客户的操作人员;按用户名识别,空列表表示尚未分配。
    操作人员可在所属租户及获准法人主体范围内查看客户,与销售归属及公海状态独立。
    operators.[].usernameString用户标识
    operators.[].nameString用户名称
    operators.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    operators.[].mobileString用户手机号
    operators.[].emailString用户邮箱
    operators.[].positionString职位
    operators.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • tagsString[]客户标签
    mainRoutesString[]主要航线(基础数据id列表)
    mainRoutesInfoObject[]主要航线信息列表
    mainRoutesInfo.[].itemIdString数据项唯一标识
    mainRoutesInfo.[].nameString数据项名称(中文)
    mainRoutesInfo.[].nameEnString数据项名称(英文)
    mainRoutesInfo.[].extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    totalTeuNumber累计箱量 (TEU)
    lastShipmentDateString最近走货日期(UTC)
    lastFollowUpDateString最近跟进日期(UTC)
    isPublicBoolean是否处于公海
    publicEnterTimeString进入公海时间(UTC)
    ownerAssignTimeString销售分配时间(UTC)
    followUpStatusString跟进状态
  • NORMAL - 正常
  • OVERDUE - 超期未跟进
  • isFirstOrderBoolean是否首次下单
    businessInfoObject商务信息
    businessInfo.settlementModeString结算方式
  • SPOT - 票结/见款放单(账期 0 天)
  • MONTHLY - 月结
  • CUSTOM - 自定义账期
  • businessInfo.creditDaysNumber账期(天)
    attachmentsObject[]客户附件
    attachments.[].titleString附件标题
    attachments.[].descriptionString附件说明
    attachments.[].binaryIdString[]附件id
    statusString状态
  • NORMAL - 正常
  • DISABLED - 禁用
  • nameString往来单位中文名(公共字段,与 Unit 同步保存)
    nameEnString往来单位英文名(公共字段,与 Unit 同步保存)
    abbreviationString往来单位简称(公共字段,与 Unit 同步保存)
    countryString往来单位所在国家/地区(公共字段,与 Unit 同步保存)
    countryEnString往来单位所在国家/地区英文名(公共字段,与 Unit 同步保存)
    addressString往来单位中文地址(公共字段,与 Unit 同步保存)
    addressEnString往来单位英文地址(公共字段,与 Unit 同步保存)
    contactPersonsObject[]联系人列表(公共字段,与 Unit 同步保存)
    contactPersons.[].usernameString用户标识
    contactPersons.[].nameString用户名称
    contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    contactPersons.[].mobileString用户手机号
    contactPersons.[].emailString用户邮箱
    contactPersons.[].positionString职位
    contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • bankAccountsObject[]银行账户列表,支持多个账户
    bankAccounts.[].accountNameString开户名称
    bankAccounts.[].bankNameString银行名称
    bankAccounts.[].bankCodeString联行号
    bankAccounts.[].bankAccountString银行账号
    bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • bankAccounts.[].swiftCodeStringSWIFT CODE
    bankAccounts.[].addressString地址
    bankAccounts.[].isDefaultBoolean是否默认
    invoiceInfoObject开票信息
    invoiceInfo.companyNameString公司名称
    invoiceInfo.taxIdentificationNumberString纳税识别号
    invoiceInfo.companyAddressString公司地址
    invoiceInfo.phoneString电话
    invoiceInfo.bankAccountString银行账号
    invoiceInfo.contactString联系人
    invoiceInfo.emailString邮箱
    remarksString备注信息
    legalEntityIdString法人主体id
    extraPropsObject扩展属性
    crByString创建者
    upByString最后修改者
    crDateString创建时间
    upDateString最后修改时间
    tenantIdString租户ID
    idVaries获取客户唯一标识

    下载结果模型定义