跳到主要内容

POST 分页(扁平)

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

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

请求体字段(body)

字段类型必填说明
pageNuminteger(int32)—页码
pageSizeinteger(int32)—每页数量
bankAccountIdinteger(int64)是账户ID
directioninteger(int32)—方向 1=收入 -1=支出
startDatestring(date)—起始日期
endDatestring(date)—结束日期
keywordstring—关键词
matchStatusinteger(int32)—对账状态 0=未匹配 1=已匹配
unlinkedOnlyboolean—是否仅查询无业务来源且无活动资金分配的流水,默认 false
supplierIdinteger(int64)—供应商ID
customerIdinteger(int64)—客户ID
counterpartNamestring—对方单位名称(精确匹配 counterpart_name;退款选流水按对方单位过滤,因导入按方向写入的 party id 列与退款方向相反)
includeFeeRowboolean—是否包含手续费明细,默认 false(手续费明细不可被选择/匹配)
excludeVoidedboolean—是否排除已冲销流水,默认 false(选择匹配流水的场景传 true)
allocatableboolean—仅查询登记付款可用流水(未匹配或部分匹配,剩余可用金额>0),默认 false

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

请求示例

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

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

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

错误处理​

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

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

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

← 返回银行流水