GET 销售合同统计
GET 统计查询。query 参数:period(可选,统计周期 month=本月、quarter=本季度、year=本年)、startDate / endDate(可选,yyyy-MM-dd,成对使用,优先于 period)、scope(可选,all=全部(默认)、mine=仅本人)、keyword(可选)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.report.contract-stats | sales:read | GET /v1/sales-report/contract-stats(comap-sales) |
请求参数(query)
本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为
string。实际取值语义见「说明」列,按自然类型 传即可(如"pageNum": 1),服务端会完成转换。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
period | string | — | 统计周期:month/quarter/year |
startDate | string | — | 自定义开始日期,格式 yyyy-MM-dd,与 endDate 配对使用,优先级高于 period |
endDate | string | — | 自定义结束日期,格式 yyyy-MM-dd,与 startDate 配对使用,优先级高于 period |
scope | string | — | 统计范围:all/mine |
keyword | string | — | 关键字 |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.report.contract-stats",
"query": {}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
metrics3 | ReportMetricVO[] | — | 指标卡片 |
trend4 | ReportTrendPointVO[] | — | 合同金额与回款趋势 |
statusDistribution3 | ReportDistributionVO[] | — | 合同状态分布饼图 |
riskItems4 | ReportHealthItemVO[] | — | 合同到期风险 |
salesPersonRanks3 | ReportRankItemVO[] | — | 销售员合同额TOP5 |
customerRanks3 | ReportRankItemVO[] | — | 客户合同额TOP5 |
productRanks3 | ReportRankItemVO[] | — | 产品合同额TOP5 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回财务报表