POST 业绩银行汇总与个人月度趋势
POST 查询。body 为 JSON 对象,筛选字段同 sales.performance.page,另可选 trendYear(趋势年份,默认当年)、includeMonthly(是否返回月度趋势,默认返回)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.performance.summary | sales:read | POST /v1/sales-performance/summary(comap-sales) |
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
pageNum | integer(int32) | — | 页码,从 1 开始 |
pageSize | integer(int32) | — | 每页返回的数量 |
contractId | integer(int64) | — | 合同ID |
salesOrderId | integer(int64) | — | 销售订单ID |
entryType | string | — | 流水方向:ORIGINAL_CONFIRM / REBOOK_OUT / REBOOK_IN / RETURN_ADJUSTMENT / RETURN_RESTORE |
salesPersonId | integer(int64) | — | 销售人员ID |
customerId | integer(int64) | — | 客户ID(业绩流水冗余 customer_id) |
teamId | integer(int64) | — | 团队ID |
status | string | — | 状态:PENDING=待确认, PENDING_APPROVAL=待审批, CONFIRMED=已确认, REBOOKED=已改帐, REJECTED=已驳回 |
keyword | string | — | 合同标题/客户名/合同编号模糊 |
ownerScope | string | — | 业绩银行归属:ALL / MINE / TEAM / WATCHED(与 {@link com.comap.sales.web.support.Performa |
viewScope | integer(int32) | — | 列表视角(兼容):1=ALL,2=MY_OWN,3=SUBORDINATES,4=FOLLOWING。若 {@link #ownerScope} 非空则优先使用 |
startDate | string | — | 开始日期 |
endDate | string | — | 结束日期 |
trendYear | integer(int32) | — | 月度趋势年份,为空取服务器当前年 |
includeMonthly | boolean | — | 是否返回月度趋势,默认返回 |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.performance.summary",
"body": {
"pageNum": 1,
"pageSize": 10
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
confirmedPerformanceAmount | number | — | 已确认业绩净额 |
confirmedGrossProfit | number | — | 已确认毛利净额 |
entryCount | integer(int64) | — | 筛选范围内流水总数 |
confirmedEntryCount | integer(int64) | — | 筛选范围内已确认流水数 |
pendingApprovalCount | integer(int64) | — | 待审批 Rebook 记录数 |
originalAmount | number | — | 原始确认金额 |
originalCount | integer(int64) | — | 原始确认笔数 |
rebookInAmount | number | — | Rebook 分入金额 |
rebookInCount | integer(int64) | — | Rebook 分入笔数 |
rebookOutAmount | number | — | Rebook 分出金额绝对值 |
rebookOutCount | integer(int64) | — | Rebook 分出笔数 |
salesPersonId | integer(int64) | — | 业绩归属人 ID |
salesPersonName | string | — | 业绩归属人名称 |
teamName | string | — | 销售团队名称 |
trendYear | integer(int32) | — | 趋势年份 |
monthly5 | MonthlyDirectionVO[] | — | 1 至 12 月业绩方向趋势 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回performance