跳到主要内容

GET 销售合同分页查询

GET 分页查询。query 参数:pageNum、pageSize 及合同筛选字段。

接口编码所需范围后端接口
sales.contract.pagesales:readGET /v1/sales-contract/page(comap-sales)

请求参数(query)

字段类型必填说明
keywordstring—关键词(模糊搜索合同编号/标题/项目名称)
customerIdstring—客户ID
opportunityIdstring—关联商机ID
includeSubsidiarystring—是否包含客户作为关联单位(分/子公司)且有下单权限的合同
statusstring—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
bizStatusstring—业务状态:0=执行中, 1=已完成, 2=已终止
ownerIdstring—负责人ID
ownerScopestring—范围:ALL-全部 MINE-我负责 TEAM-团队下属负责 FOLLOWED/WATCHED-我关注客户的合同
signDateStartstring—签订日期开始
signDateEndstring—签订日期结束
amountMinstring—金额下限
amountMaxstring—金额上限
contactNamestring—客户联系人名称(模糊搜索)
ownerNamestring—负责人名称(模糊搜索)
invoiceFilterstring—开票进度筛选: full-已全部开票 / partial-部分开票 / none-未开票
paymentFilterstring—收款进度筛选: full-已全部收款 / partial-部分收款 / none-未收款
deliveryFilterstring—发货进度筛选: full-已全部发货 / partial-部分发货 / none-未发货
advancedFiltersstring—高级字段筛选条件(JSON字符串),支持 {"field":{"op":"contains","value":"xxx"}}
sortFieldstring—列表排序字段:contractNo / status / bizStatus / totalAmount / createTime / updateTime,默
sortOrderstring—列表排序方向:asc / desc,默认 desc
createTimeStartstring—创建时间下限(含),nullable。历史 caller 不构造保持行为不变; 非空时 wrapper 追加 .ge(create_time, createTi
createTimeEndstring—创建时间上限(不含),nullable。历史 caller 不构造保持行为不变; 非空时 wrapper 追加 .lt(create_time, createT
bizStatusesstring—业务状态 IN 列表,nullable。历史 caller 不构造保持行为不变; 非空时 wrapper 追加 .in(biz_status, bizStatu
ownerIdsstring—负责人 ID IN 列表,nullable。历史 caller 不构造保持行为不变; 非空时走 ownerIds 分支,绕过 applyOwnerScope,等
allDatastring—是否查询全量数据,nullable。仅在 ownerIds 分支生效;true 表示不再按 ownerId 过滤, 等价旧 XML {@code <choose
includeCreatorsstring—是否额外把创建人(create_by)纳入 ownerIds 分支的过滤范围,nullable。 true 时条件为 (owner_id IN ownerIds
orderPlacedboolean——
pageNumstring—页码,从 1 开始
pageSizestring—每页返回的数量

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.contract.page",
"query": {
"pageNum": 1,
"pageSize": 10
}
}'

响应 data 字段(分页结构:records[] + total)

字段类型必填说明
sizeinteger(int64)——
records35ContractPageVO[]——
totalinteger(int64)——
currentinteger(int64)——
pagesinteger(int64)——

错误处理​

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

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

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

← 返回销售合同