跳到主要内容

POST 销售收款流水汇总

POST 查询。条件同分页查询:body 为 JSON 对象:可选 customerId(客户ID)、keyword(关键字)、nameKeyword(往来名称)、startDate/endDate(收款日期范围 yyyy-MM-dd)、amount(收款金额)、allocStatus(分配状态:UNALLOCATED 未分配 / PARTIAL 部分分配 / ALLOCATED 已分配)、current(页码,默认1)、size(每页条数,默认20)。

接口编码所需范围后端接口
sales.collection-flow.summarysales:readPOST /v1/sales-collection/flows/summary(comap-sales)

请求体字段(body)

字段类型必填说明
currentinteger(int32)—当前页
sizeinteger(int32)—每页条数
customerIdinteger(int64)—客户 ID
keywordstring—关键字
nameKeywordstring—往来名称
preferredNamestring—优先客户名称
partyScopeOnlyboolean—是否只看本往来单位的流水(名称一致 或 已匹配该客户)
partyScopeIdinteger(int64)—往来单位范围客户 ID
startDatestring(date)—收款开始日期
endDatestring(date)—收款结束日期
amountnumber—收款金额
allocStatusstring—分配状态过滤

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.collection-flow.summary",
"body": {
"current": 1,
"size": 10
}
}'

响应 data 字段

字段类型必填说明
totalAmountnumber—总金额
allocatedAmountnumber—已分配金额
unallocatedAmountnumber—未分配金额
totalCountinteger(int64)—总数量
unallocatedCountinteger(int64)—未分配数量
partialCountinteger(int64)—部分数量
allocatedCountinteger(int64)—已分配数量
pendingCountinteger(int64)—待分配统计(待分配 + 部分分配 笔数)

错误处理​

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

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

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

← 返回collection-flow