合同管理-合同详情

调用此接口获取合同的详情，支持子公司的合同查询。

请求参数

Query 参数

contractId

string

可选

合同ID，合同ID于业务ID二选一，不能同时为空

bizId

string

可选

业务ID，合同ID于业务ID二选一，不能同时为空

tenantName

string

可选

子公司名称，若使用业务ID查询合同详情，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

queryActionOperator

string

可选

是否查询签署人的信息：如果签署动作已启动时返回待签署人，签署动作已完成时返回实际签署人；如果签署方是平台方或平台方的子公司，才会返回签署人信息

queryLocation

string

可选

是否查询签署方签署位置信息

queryRelatedContract

string

是否查询关联合同

可选

querySealStats

string

可选

是否查询印章签署次数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object (ContractResponse)

必需

string

合同ID

可选

tenantName

string

发起方名称

可选

subject

string

合同主题（合同名称）

可选

description

string

合同描述

可选

string

合同编号

可选

expireTime

string

过期时间

可选

publishTime

string

合同发起时间

可选

category

object

业务分类

可选

creator

object (UserResponse)

创建人

可选

signatories

array[object (SignatoryResponse) {14}]

签署方

可选

签署合同的公司/个人

documents

array[object (DocumentResponse) {6}]

合同文档

可选

comments

string

合同已撤回/已退回状态时的原因说明

可选

invalidReason

string

合同作废中/已作废状态时的作废原因

可选

endTime

string

文件的终止时间

可选

signFlowStrategy

string

接收方签署策略

可选

ANY_SIGN_FINISH（任意一个接收方签署完成，则合同完成）

relatedContractIds

array[string]

否

可选

customFields

array[object (ContractCustomFieldResponse) {7}]

合同自定义参数

可选

copySendReceivers

array[object (CopySendReceiverResponse) {4}]

合同抄送人

可选

businessData

string

自定义业务参数

可选

示例

{
  "result": {
    "id": "3053227767890968697",
    "subject": "接口发起",
    "description": "合同描述",
    "sn": "接口发起",
    "tenantName": "思晨教育",
    "ordinal": true,
    "category": {
      "id": "3053202902198805409",
      "name": "自动化测试-勿动zxs"
    },
    "creator": {
      "name": "韩军超",
      "contact": "18663049557",
      "contactType": "MOBILE"
    },
    "status": "SIGNING",
    "expireTime": "2023-03-19 00:00:00",
    "publishTime": "2023-01-18 15:17:08",
    "signatories": [
      {
        "id": "3053227768113266811",
        "tenantType": "COMPANY",
        "status": "SIGNING",
        "tenantName": "思晨教育",
        "receiver": {
          "name": "韩军超",
          "contact": "18663049557",
          "contactType": "MOBILE"
        },
        "serialNo": 0,
        "actions": [
          {
            "id": "3053227768201347196",
            "type": "AUDIT",
            "status": "START",
            "name": "审批动作",
            "serialNo": 0,
            "autoSign": false,
            "operators": [
              {}
            ]
          },
          {
            "id": "3053227768226513022",
            "type": "LP",
            "status": "INIT",
            "name": "法人签署动作",
            "serialNo": 1,
            "autoSign": false
          },
          {
            "id": "3053227768289427583",
            "type": "COMPANY",
            "status": "INIT",
            "name": "公章签署动作",
            "serialNo": 2,
            "autoSign": false,
            "operators": [
              {}
            ]
          }
        ],
        "delaySet": false,
        "sponsor": true
      },
      {
        "id": "3053227768331370625",
        "tenantType": "PERSONAL",
        "status": "WAITING",
        "tenantName": "韩军超",
        "receiver": {
          "contact": "18663049557",
          "contactType": "MOBILE"
        },
        "serialNo": 1,
        "delaySet": false,
        "sponsor": false
      },
      {
        "id": "3053227780717150393",
        "tenantType": "PERSONAL",
        "status": "WAITING",
        "tenantName": "程桂英",
        "receiver": {
          "contact": "18161426316",
          "contactType": "MOBILE"
        },
        "serialNo": 2,
        "delaySet": false,
        "sponsor": false
      }
    ],
    "documents": [
      {
        "id": "3053227770336247942",
        "title": "ces",
        "pageCount": 2,
        "createTime": "2023-01-18 15:17:07",
        "contentType": "CONTRACT",
        "params": []
      },
      {
        "id": "3053227772693446794",
        "title": "V2添加模板文档",
        "pageCount": 6,
        "createTime": "2023-01-18 15:17:07",
        "contentType": "CONTRACT",
        "params": [
          {
            "name": "乙方姓名",
            "value": "张三",
            "required": false,
            "type": "text"
          },
          {
            "name": "身份证号",
            "required": false,
            "type": "text"
          },
          {
            "name": "合同开始时间",
            "required": false,
            "type": "text"
          },
          {
            "name": "合同截止时间",
            "required": false,
            "type": "text"
          },
          {
            "name": "试用期开始时间",
            "required": false,
            "type": "text"
          },
          {
            "name": "试用期截止时间",
            "required": false,
            "type": "text"
          },
          {
            "name": "薪资",
            "required": false,
            "type": "text"
          },
          {
            "name": "薪资大写",
            "required": false,
            "type": "text"
          },
          {
            "name": "乙方姓名2",
            "required": false,
            "type": "text"
          },
          {
            "name": "乙方姓名3",
            "required": false,
            "type": "text"
          }
        ]
      }
    ],
    "copySendReceivers": [
      {
        "name": "{{userName}}",
        "receiver": {
          "contact": "18663049557",
          "contactType": "MOBILE"
        },
        "createTime": "2023-01-18 15:17:09",
        "send": false
      }
    ]
  },
  "code": 0,
  "message": "SUCCESS"
}