跳到主要内容

POST 创建商务函件(可直接提交审批)

POST 新增,body 为 JSON 对象。必填:orderId(关联销售订单ID)、letterType(DUNNING催款函/RECONCILIATION对账函)、subject(函件主题)。可选:status(0草稿,默认;1=保存后直接提交审批;4已导出)、content(正文)、deadlineDays(期限天数)、bankAccountId(收款账户ID)、toneVersion(FRIENDLY/FORMAL/SEVERE,仅催款函)、dunningScope(CURRENT/ALL/CUSTOM)、dunningAmount(催款金额)、selectedInstallmentIds(回款期次ID JSON)、reconciliationStartDate/reconciliationEndDate(yyyy-MM-dd,仅对账函)、extraSettings(JSON)。函件编号自动生成。status=1 会发起审批流,需先与用户确认。

接口编码所需范围后端接口
sales.business-letter.createsales:writePOST /v1/business-letter/create(comap-sales)

必填字段

字段依据
orderId参数说明、接口规格
letterType参数说明、接口规格
subject参数说明、接口规格
status接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
orderIdinteger(int64)是关联销售订单 ID
letterTypestring是函件类型:DUNNING-催款函, RECONCILIATION-对账函
subjectstring是函件主题
toneVersionstring—语气版本:FRIENDLY / FORMAL / SEVERE(仅催款函)
statusinteger(int32)是状态:0-草稿, 1-待审批, 4-已导出
contentstring—函件正文内容
deadlineDaysinteger(int32)—回复/付款期限天数
bankAccountIdinteger(int64)—关联收款银行账户 ID(指向 finance 模块 bank_account)
dunningScopestring—催款范围:CURRENT / ALL / CUSTOM(仅催款函)
dunningAmountnumber—催款金额(仅催款函)
selectedInstallmentIdsstring—已选择的回款期次 ID 列表 JSON(仅催款函 CURRENT 范围)
reconciliationStartDatestring—对账起始日期,格式 yyyy-MM-dd(仅对账函)
reconciliationEndDatestring—对账截止日期,格式 yyyy-MM-dd(仅对账函)
extraSettingsstring—附加设置 JSON

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.business-letter.create",
"body": {
"orderId": "1961000000000000001",
"letterType": "string",
"subject": "string",
"status": 0
}
}'

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回business-letter