跳到主要内容

GET 结算可核销收款流水

GET 查询可用于核销本结算单应收的收款单与银行到账流水(范围由服务端按客户与已确认到账限定),仅「客户已确认/已收款」的结算单可查。query 参数:id(必填,结算单ID)。返回 sourceKind 区分收款单/银行流水,applicableAmount 为本次可核销金额。

接口编码所需范围后端接口
sales.service-settlement.collection-candidatessales:readGET /v1/service-orders/settlement/collection/candidates(comap-sales)

请求参数(query)

字段类型必填说明
idinteger(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 字段

字段类型必填说明
sourceKindstring—来源类型:COLLECTION 收款单 / BANK_TXN 银行流水
idinteger(int64)—记录 ID。sourceKind=COLLECTION 时为收款单 ID,=BANK_TXN 时为银行流水 ID
collectionNostring—流水号(收款单号或银行流水号)
paymentDatestring(date)—到账日期
partyNamestring—付款方
amountnumber—流水金额
availableAmountnumber—可用金额(未核销余额 / 流水未被占用额)
statusstring—状态码
statusLabelstring—状态中文名
paymentMethodstring—收款方式
applicableAmountnumber—选中后本次可核销金额

错误处理​

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

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

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

← 返回service-settlement