GET 查询客户授信概览
GET 查询。query 参数:customerId(客户ID,必填)。返回该客户授信额度、已用、可用、冻结状态、结算条件等。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.credit.overview | sales:read | GET /v1/customer/credit/overview(comap-sales) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
customerId | integer(int64) | 是 | — |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.credit.overview",
"query": {
"customerId": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
creditLimit | number | — | 授信额度 |
creditValidTo | string(date-time) | — | 授信有效期至 |
usedAmount | number | — | 已占用金额(应收款占用) |
availableAmount | number | — | 剩余可用额度 |
usagePercent | number | — | 占用比例(百分比,如 26) |
status | string | — | 授信状态:正常/预警/超限 |
usageRiskLevel | integer(int32) | — | 额度使用率风险档位:0正常 1预警 2超限 |
customerName | string | — | 客户名称 |
customerType | string | — | 客户类型(分类名称) |
paymentDays | integer(int32) | — | 账期天数 |
salesOwner | string | — | 负责人姓名 |
overdueAmount | number | — | 逾期/风险占用金额合计 |
overdueCount | integer(int32) | — | 逾期/风险笔数 |
creditFrozen | boolean | — | 授信是否冻结 |
creditFrozenAt | string(date-time) | — | 冻结时间 |
creditFrozenBy | string | — | 冻结操作人 |
creditFrozenReason | string | — | 冻结原因 |
settlementTerm | string | — | 结算条件(如:发货后60天) |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回credit