跳到主要内容

POST 更新商务函件(可直接提交审批)

POST 更新,body 为 JSON 对象。必填:id。仅草稿/已驳回可改;按字段部分更新,只改传入的非空字段(subject、content、toneVersion、deadlineDays、bankAccountId、dunningScope、dunningAmount、selectedInstallmentIds、reconciliationStartDate、reconciliationEndDate、extraSettings、status)。status=1 会发起审批流,需先与用户确认。

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

必填字段

字段依据
id参数说明、接口规格

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

请求体字段(body)

字段类型必填说明
idinteger(int64)是函件 ID
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.update",
"body": {
"id": "1961000000000000001"
}
}'

错误处理​

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

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

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

← 返回business-letter