跳到主要内容

POST 修改付款模板

POST 修改付款条件模板(部分更新)。body 为 JSON:必填 id;可选 templateName(传入时不能为空)、paymentMode、stages(传入即整体替换;从全额预收改为分阶段时必须带阶段,合计100)、note、isDefault、active。

接口编码所需范围后端接口
sales.service-order.config.payment-template.updatesales:writePOST /v1/service-orders/config/payment-template/update(comap-sales)

必填字段

字段依据
id参数说明、接口规格
stages[].stageName接口规格
stages[].percent接口规格

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

请求体字段(body)

字段类型必填说明
idinteger(int64)是付款模板ID
templateNamestring—模板名
paymentModestring—付款方式:upfront 全款预付 / milestone 分阶段
stages3ServicePaymentTemplateStageDTO[]—付款阶段明细;传了就整体替换,不传不动。仅 milestone 有效,比例合计必须为 100
notestring—模板默认备注(开票约定、迟付滞纳等)
isDefaultinteger(int32)—是否默认模板:0否 1是;设为 1 时同租户其它模板的默认标记会被清零
activeinteger(int32)—是否启用:0停用 1启用

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.service-order.config.payment-template.update",
"body": {
"id": "1961000000000000001"
}
}'

响应 data 字段

字段类型必填说明
idinteger(int64)—付款模板ID
templateNamestring—模板名,如「标准 30-50-20」
paymentModestring—付款方式:upfront 全款预付 / milestone 分阶段
stages5ServicePaymentTemplateStageVO[]—付款阶段明细,按阶段序号升序;upfront 时为空列表
notestring—模板默认备注(开票约定、迟付滞纳等)
isDefaultinteger(int32)—是否默认模板:0否 1是;新建报价时自动套用
activeinteger(int32)—是否启用:0停用 1启用
createTimestring(date-time)—创建时间
updateTimestring(date-time)—更新时间

错误处理​

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

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

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

← 返回服务工单-服务配置