跳到主要内容

GET 查询客户授信概览

GET 查询。query 参数:customerId(客户ID,必填)。返回该客户授信额度、已用、可用、冻结状态、结算条件等。

接口编码所需范围后端接口
sales.credit.overviewsales:readGET /v1/customer/credit/overview(comap-sales)

请求参数(query)

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

字段类型必填说明
creditLimitnumber—授信额度
creditValidTostring(date-time)—授信有效期至
usedAmountnumber—已占用金额(应收款占用)
availableAmountnumber—剩余可用额度
usagePercentnumber—占用比例(百分比,如 26)
statusstring—授信状态:正常/预警/超限
usageRiskLevelinteger(int32)—额度使用率风险档位:0正常 1预警 2超限
customerNamestring—客户名称
customerTypestring—客户类型(分类名称)
paymentDaysinteger(int32)—账期天数
salesOwnerstring—负责人姓名
overdueAmountnumber—逾期/风险占用金额合计
overdueCountinteger(int32)—逾期/风险笔数
creditFrozenboolean—授信是否冻结
creditFrozenAtstring(date-time)—冻结时间
creditFrozenBystring—冻结操作人
creditFrozenReasonstring—冻结原因
settlementTermstring—结算条件(如:发货后60天)

错误处理​

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

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

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

← 返回credit