跳到主要内容

POST 分页查询

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

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

请求体字段(body)

字段类型必填说明
pageNuminteger(int32)—页码,默认 1
pageSizeinteger(int32)—每页大小,默认 20
refundTypestring—退款类型 CUSTOMER/SUPPLIER
scenariostring—退款场景 REFUND_ONLY/RETURN_AND_REFUND
statusesstring[]—单据状态 IN 过滤
financeApprovalStatusesstring[]—财务审批状态 IN 过滤
paymentStatusesstring[]—付款状态 IN 过滤
writeOffStatusesstring[]—核销状态 IN 过滤
partyIdinteger(int64)—关联方ID
contractIdstring—合同ID
applyDateFromstring(date)—申请日期起
applyDateTostring(date)—申请日期止
amountMinnumber—申请退款金额下限
amountMaxnumber—申请退款金额上限
keywordstring—关键词(单号/合同/关联方名称)
orderBystring—排序字段 apply_date/refund_amount/actual_refund
orderDirstring—排序方向 asc/desc

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

请求示例

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

响应 data 字段(分页结构:records[] + total)

字段类型必填说明
sizeinteger(int64)——
records31RefundApplicationPageVO[]——
totalinteger(int64)——
currentinteger(int64)——
pagesinteger(int64)——

错误处理​

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

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

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

← 返回退款单