跳到主要内容

POST 详情

POST 查询。body 为筛选条件 JSON(分页类含 pageNum、pageSize)。

接口编码所需范围后端接口
finance.refund.detailfinance:readPOST /v1/refund/detail(comap-finance)

请求体字段(body)

字段类型必填说明
idinteger(int64)是主键 ID

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "finance.refund.detail",
"body": {
"id": "1961000000000000001"
}
}'

响应 data 字段

字段类型必填说明
idinteger(int64)—ID
refundNostring—退款编号
refundTypestring—CUSTOMER=客户退款, SUPPLIER=供应商退款
scenariostring—场景
partyIdinteger(int64)—往来单位ID
partyNamestring—往来单位名称
contractIdstring—合同ID
contractTitlestring—合同标题
returnOrderIdstring—退货单ID
returnOrderNostring—退货单编号
sourceOrderIdstring—来源订单ID
sourceOrderNostring—来源订单编号
applicantNamestring—申请人
currencyCodestring—币种编码
currencySymbolstring—币种符号
exchangeRatenumber—汇率
refundAmountnumber—退款金额
refundFeenumber—退款手续费
actualRefundnumber—实际退款
actualRefundBasenumber—实际退款base
refundMethodstring—BANK=银行卡, WECHAT=微信, ALIPAY=支付宝, OTHER=其他
refundMethodIdinteger(int64)—退款methodID
refundAccountLabelstring—退款账户label
statusstring—DRAFT=草稿, PENDING=待付款, PARTIAL=部分付款, SETTLED=已结清, VOID=已作废
financeApprovalStatusstring—财务审批状态
approverNamestring—审批人名称
paymentStatusstring—PENDING=待付款, PAID=已付款, NOT_APPLICABLE=不适用
writeOffStatusstring—PENDING=待核销, WRITTEN_OFF=已核销, NOT_APPLICABLE=不适用
applyDatestring(date)—申请日期
operatorNamestring—操作人名称
createTimestring(date-time)—创建时间
contractTotalnumber—合同合计
refundAmountBasenumber—退款amountbase
refundAccountBankstring—退款账户银行
refundAccountNumberstring—退款账户number
refundAddressstring—退款address
approvalCommentstring—审批意见
approvalDatestring(date-time)—审批日期
flowInstanceCodestring—流程实例编码
paymentDatestring(date)—付款日期
paymentTransactionIdstring—付款transactionID
paymentBankAccountstring—付款银行账户
writeOffDatestring(date)—核销日期
linkedBankFlowstring—已关联银行流程
linkedBankFlowDatestring(date)—已关联银行流程日期
linkedBankFlowAmountnumber—已关联银行流程金额
reasonstring—原因
remarkstring—备注
payments5ContractPaymentItemVO[]—合同付款/收款明细列表
deliveries5ContractDeliveryItemVO[]—合同到货明细列表
redBillIdinteger(int64)—红字账单 ID
redBillNostring—红字账单号
redBillTypestring—红字账单类型:AR=应收, AP=应付
arApOffsetAmountnumber—冲抵正向应收/应付金额
advanceOffsetAmountnumber—冲抵预收/预付金额
cashRefundAmountnumber—现金退款/收款金额
settlementStatusstring—结算状态:PENDING=待核销, WRITTEN_OFF=已核销, NOT_APPLICABLE=不适用
settlementSummarystring[]—结算摘要
fileIdsinteger(int64)[]—关联附件 fileId 列表(前端根据 id 调用 file 服务取详情)

错误处理​

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

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 finance:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

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

← 返回退款单