POST 更新退款申请(仅草稿)
POST。body 为 JSON 对象,字段结构见接口参考。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
finance.refund.update | finance:write | POST /v1/refund/update(comap-finance) |
必填字段
| 字段 | 依据 |
|---|---|
refundType | 接口规格 |
scenario | 接口规格 |
partyName | 接口规格 |
currencyCode | 接口规格 |
refundAmount | 接口规格 |
refundMethod | 接口规格 |
applyDate | 接口规格 |
reason | 接口规格 |
id | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
refundType | string | 是 | 退款类型 CUSTOMER/SUPPLIER |
scenario | string | 是 | 退款场景 REFUND_ONLY/RETURN_AND_REFUND |
partyId | integer(int64) | — | 关联方ID |
partyName | string | 是 | 关联方名称(客户/供应商) |
contractId | string | — | 关联合同ID |
contractTitle | string | — | 合同标题(快照) |
contractTotal | number | — | 合同总额(快照) |
returnOrderId | string | — | 关联退货单号 |
currencyCode | string | 是 | 币种编码 |
currencySymbol | string | — | 币种符号 |
exchangeRate | number | — | 汇率(兑本位币),默认 1 |
refundAmount | number | 是 | 退款金额(原币) |
refundFee | number | — | 退款手续费(原币) |
refundMethod | string | 是 | 退款方式:BANK=银行卡, WECHAT=微信, ALIPAY=支付宝, OTHER=其他 |
refundMethodId | integer(int64) | — | 退款方式ID |
refundAccountId | integer(int64) | — | 退款账户ID |
refundAccountBank | string | — | 退款账户开户行(快照) |
refundAccountNumber | string | — | 退款账户号(快照) |
refundAccountLabel | string | — | 退款账户展示名(快照) |
refundAddress | string | — | 退货收/发货地址 |
applyDate | string(date) | 是 | 申请日期 |
reason | string | 是 | 退款原因 |
remark | string | — | 备注 |
submit | boolean | — | 是否提交审批(true-直接进入待审批,false-保存为草稿) |
id | integer(int64) | 是 | 退款申请 ID |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "finance.refund.update",
"body": {
"id": "1961000000000000001",
"refundType": "string",
"scenario": "string",
"partyName": "string",
"currencyCode": "string",
"refundAmount": 0,
"refundMethod": "string",
"applyDate": "string",
"reason": "string"
}
}'
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 finance:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回退款单