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.create | sales:write | POST /v1/business-letter/create(comap-sales) |
必填字段
| 字段 | 依据 |
|---|---|
orderId | 参数说明、接口规格 |
letterType | 参数说明、接口规格 |
subject | 参数说明、接口规格 |
status | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
orderId | integer(int64) | 是 | 关联销售订单 ID |
letterType | string | 是 | 函件类型:DUNNING-催款函, RECONCILIATION-对账函 |
subject | string | 是 | 函件主题 |
toneVersion | string | — | 语气版本:FRIENDLY / FORMAL / SEVERE(仅催款函) |
status | integer(int32) | 是 | 状态:0-草稿, 1-待审批, 4-已导出 |
content | string | — | 函件正文内容 |
deadlineDays | integer(int32) | — | 回复/付款期限天数 |
bankAccountId | integer(int64) | — | 关联收款银行账户 ID(指向 finance 模块 bank_account) |
dunningScope | string | — | 催款范围:CURRENT / ALL / CUSTOM(仅催款函) |
dunningAmount | number | — | 催款金额(仅催款函) |
selectedInstallmentIds | string | — | 已选择的回款期次 ID 列表 JSON(仅催款函 CURRENT 范围) |
reconciliationStartDate | string | — | 对账起始日期,格式 yyyy-MM-dd(仅对账函) |
reconciliationEndDate | string | — | 对账截止日期,格式 yyyy-MM-dd(仅对账函) |
extraSettings | string | — | 附加设置 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