GET 销售合同详情

GET 查询。query 参数：id（合同ID，必填）。

接口编码	所需范围	后端接口
sales.contract.detail	sales:read	GET /v1/sales-contract/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.contract.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
id	integer(int64)	—	ID
contractNo	string	—	合同编号
customerOrderNo	string	—	客户单号
title	string	—	标题
contractType	string	—	合同类型，关联合同类型配置表
contractTypeId	integer(int64)	—	合同类型ID
customerId	integer(int64)	—	客户ID
customerName	string	—	客户名称
customerAddress	string	—	客户地址
customerCreditCode	string	—	客户统一社会信用代码
customerBankName	string	—	客户开户银行
customerBankAccount	string	—	客户银行账号
customerPrimaryContact	string	—	客户主要联系人
customerPrimaryPhone	string	—	客户主要联系人电话
contactName	string	—	联系人姓名
contactPhone	string	—	联系人电话
contactEmail	string	—	联系人邮箱
address	string	—	地址
projectName	string	—	项目名称
projectNo	string	—	项目编号
projectId	integer(int64)	—	项目ID
linkedProjects3	ContractLinkedProjectVO[]	—	项目中心关联的项目（按关联先后排序，为空时按合同快照展示）
orderType	string	—	订单类型：PTS=按库存销售, PTO=按订单采购, PTM=按单生产
signDate	string(date-time)	—	签订日期
startDate	string(date-time)	—	开始日期
endDate	string(date-time)	—	结束日期
paymentTermId	integer(int64)	—	付款条件ID
paymentTermName	string	—	付款方式名称（主数据 t_sales_payment_term.name）
deliveryDays	integer(int32)	—	交货天数
warrantyMonths	integer(int32)	—	质保月数
totalAmount	number	—	总金额
invoicedAmount	number	—	已开票金额
paidAmount	number	—	已付金额
deliveredRate	number	—	已下单发货率（%）；分母为已下单量；无物料合同为 null
orderCoverageRate	number	—	合同订单覆盖率（%）= 已下单净额/合同额
acceptanceDeliveryRate	number	—	合同发货交付率（%）= 已验收金额/合同额；无物料合同为 null
hasMaterialItems	integer(int32)	—	是否含物料行：1=含 0=不含
quotationId	integer(int64)	—	报价单ID
opportunityId	integer(int64)	—	商机ID
companyHeaderId	integer(int64)	—	公司抬头ID
companyBankAccountId	integer(int64)	—	公司资金账户ID
companyBankAccountNo	string	—	公司银行账号
companyBankName	string	—	公司开户行
ownerId	integer(int64)	—	负责人ID
ownerName	string	—	负责人名称
ownerAvatar	string	—	负责人头像
ownerPhone	string	—	负责人手机号
ownerDeptName	string	—	经办人所属部门名称（来自用户主数据）
collaborators4	ContractCollaboratorVO[]	—	协同销售
status	integer(int32)	—	状态：0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
bizStatus	integer(int32)	—	业务状态：0=执行中, 1=已完成, 2=已终止
trafficLightColor	string	—	红绿灯颜色：red/yellow/green/none
trafficLightReason	string	—	红绿灯说明
trafficLightSource	string	—	红绿灯来源：manual=手动, auto=自动
trafficLightUpdatedAt	string(date-time)	—	红绿灯最近更新时间
remark	string	—	备注
createByName	string	—	开单人名称
createTime	string(date-time)	—	创建时间
contractTerms	string	—	合同条款正文
revenueRecognitionMode	string	—	收入确认模式：MANUAL=手动, SHIPMENT=按发货出库, INVOICE=按开票, MILESTONE=按里程碑, PERIOD=按周期
expenses16	ContractExpenseVO[]	—	费用项目
revenuePeriodMeta3	ContractRevenuePeriodMetaVO	—	按周期计费元数据
revenueLines17	ContractRevenueLineVO[]	—	收入确认明细
items40	ContractItemVO[]	—	明细行
paymentPlans10	PaymentPlanVO[]	—	回款计划
paymentRecords11	ContractPaymentRecordVO[]	—	回款登记记录
attachments7	ContractAttachmentVO[]	—	附件
timelines5	ContractTimelineVO[]	—	操作日志
orderAmountLimit	number	—	合同总下单金额上限（含税），null 表示不限制
allowOffContract	boolean	—	是否允许协议外商品下单
requireApprovalInScope	boolean	—	框架和额度内下单是否需要审批
subsidiaries7	ContractSubsidiaryVO[]	—	分/子公司或关联公司授权列表
followed	boolean	—	是否已关注
hasPerformanceEntry	boolean	—	是否已在 t_sales_performance_entry 存在该合同的业绩流水（含待确认/审批中等任意状态）
flowInstanceCode	string	—	审批流实例编号
approvalHistoryInstanceCode	string	—	审批历史查询实例编号，不代表当前有效审批实例
orders13	OrderBriefVO[]	—	关联订单列表
customerChargeUserName	string	—	客户销售负责人姓名
customerChargeUserDeptName	string	—	客户销售负责人部门
customerChargeUserPhone	string	—	客户销售负责人手机号
customFieldValues	object	—	统一字段自定义字段值

错误处理

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

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

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

← 返回销售合同