GET 结算可核销收款流水
GET 查询可用于核销本结算单应收的收款单与银行到账流水(范围由服务端按客户与已确认到账限定),仅「客户已确认/已收款」的结算单可查。query 参数:id(必填,结算单ID)。返回 sourceKind 区分收款单/银行流水,applicableAmount 为本次可核销金额。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.service-settlement.collection-candidates | sales:read | GET /v1/service-orders/settlement/collection/candidates(comap-sales) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | 是 | 结算单ID |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.service-settlement.collection-candidates",
"query": {
"id": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
sourceKind | string | — | 来源类型:COLLECTION 收款单 / BANK_TXN 银行流水 |
id | integer(int64) | — | 记录 ID。sourceKind=COLLECTION 时为收款单 ID,=BANK_TXN 时为银行流水 ID |
collectionNo | string | — | 流水号(收款单号或银行流水号) |
paymentDate | string(date) | — | 到账日期 |
partyName | string | — | 付款方 |
amount | number | — | 流水金额 |
availableAmount | number | — | 可用金额(未核销余额 / 流水未被占用额) |
status | string | — | 状态码 |
statusLabel | string | — | 状态中文名 |
paymentMethod | string | — | 收款方式 |
applicableAmount | number | — | 选中后本次可核销金额 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。