GET 框架协议详情

GET。query 参数：id（协议ID，必填）。

接口编码	所需范围	后端接口
`sales.framework-agreement.detail`	`sales:read`	`GET /v1/sales/framework-agreement/detail`（comap-sales）

请求参数（query）

字段	类型	必填	说明
`id`	integer(int64)	是	—

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "sales.framework-agreement.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	integer(int64)	—	ID
`agreementNo`	string	—	协议编号
`customerId`	integer(int64)	—	客户ID
`customerName`	string	—	客户名称
`contact`	string	—	联系人
`validFrom`	string(date-time)	—	有效开始日期
`validTo`	string(date-time)	—	有效结束日期
`noEndDate`	integer(int32)	—	无结束日期
`remark`	string	—	备注
`itemCount`	integer(int32)	—	明细数量
`totalAmount`	number	—	总金额
`status`	integer(int32)	—	状态：0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
`statusLabel`	string	—	与列表页一致的展示状态
`flowInstanceCode`	string	—	流程实例编码
`createTime`	string(date-time)	—	创建时间
`updateTime`	string(date-time)	—	更新时间
`items`14	FrameworkAgreementItemVO[]	—	协议物料明细

错误处理

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

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

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

← 返回framework-agreement

错误处理​

错误处理