合同管理-创建合同草稿

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

id

string

合同ID

可选

接口返回值

bizId

string

业务ID

可选

一个合同对应一个bizId，不能重复

tenantName

string

子公司名称

可选

若需以子公司身份发起合同需要传递该值，默认为对接方公司

subject

string

合同主题

可选

若业务分类中未配置文件主题按规则生成，则需要传递

description

string

合同描述

可选

sn

string

合同编号

可选

可由用户传入，也可由契约锁自动生成

expireTime

string

合同过期时间

可选

格式为yyyy-MM-dd HH:mm:ss，默认过期时间为业务分类中配置的时

endTime

string

合同终止时间

可选

格式为yyyy-MM-dd HH:mm:ss，传递后会重置为当天23:59:59

ordinal

boolean

是否顺序签署

可选

默认为true

send

string

是否发起合同

可选

发起合同后不能再进行添加文档、指定签署位置等操作

category

object (CategoryRequest)

业务类型

可选

仅公司类型接收方（内部企业）生效，可指定该签署方对应的业务分类

delaySet

boolean

是否延迟设置签署方信息

可选

默认为false

signFlowStrategy

enum<string>

接收方签署策略

可选

枚举值:

ALL_SIGN_FINISHANY_SIGN_FINISH

templateParams

array [object {3}]

模板参数

可选

用于文件模板的填参

name

string

要修改的参数名称

必需

value

string

文档参数值

必需

单行文本字数限制：1000 当使用html模板时，合同文档参数的value值说明： > 参数类型是单行文本时，value大小不超过1000; > 参数类型是日期时，value格式为：yyyy-MM-dd，如：2019-06-04; > 参数类型是身份证号，value只能是15或18位的数字或字母，如：123456789123456789; > 参数类型是单选，value只能是单选的选项,如：val1; > 参数类型是多选，value只能是多选的选项，多个value用逗号隔开，如：val1,val2; > 参数类型是表格，value是一个Map（键值对）数组，每个Map对应表格的每行，Map的key和value对应列名和值，示例如下： [{"column1":"1","column2":"2","column3":"3","column4":"4"},{"column1":"5","column2":"6","column3":"7","column4":"8"}]表示一个2行4列的表格。 > 参数类型是图片，value是图片的base64格式加前缀「data:image/png;base64,」，其中image/png为实际的图片格式，示例如下：data:image/png;base64,/9j/4AAQSk...

readOnly

string

参数是否只读

可选

默认为false;传入true时，在页面上进行合同填参时该参数不可编辑

documents

array[object (DocumentRequest) {4}]

合同文档

可选

接口返回值

id

string

附件ID

可选

title

string

名称

可选

pageCount

integer

文档页数

可选

createTime

string

创建时间

可选

格式为yyyy-MM-dd HH:mm:ss

copySendReceivers

array[object (CopySendReceiverRequest) {4}]

抄送人列表

可选

name

string

抄送人姓名

必需

receiver

object

抄送人联系方式

必需

联系方式类型只允许使用Mobile、Email

createTime

string

创建时间

可选

格式为yyyy-MM-dd HH:mm:ss

send

string

是否已经抄送

可选

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/draft' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sn": "0219",
  "subject": "测试回调SaaS空20",
  "description": "合同描述",
  "expireTime": "2022-12-27 23:59:58",
  "endTime":"2022-12-27 00:00:00",
  "ordinal": false,
  "send": true,
  "tenantName": "上海契约锁电子合同签名有限公司",
  "creator": {
    "contact": "15021504325",
    "contactType": "MOBILE"
  },
 
  "signatories": [{
      "tenantType": "COMPANY",
      "tenantName": "上海契约锁电子合同签名有限公司",
      "receiver": {
        "contact": "15021504325",
        "contactType": "MOBILE"
      },
      "serialNo": 1,
      "actions": [{
        "type": "COMPANY",
        "name": "单位签章" 
      }]
  },
    {
      "tenantType": "PERSONAL",
       "tenantName": "朱明月",
           "receiver": {
                "contact": "test001",
                "contactType": "BIZID"
            },
      "delaySet":"true",
      "serialNo": "4"
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
  "result": {
    "id": "3053227767890968697",
    "subject": "接口发起",
    "description": "合同描述",
    "sn": "接口发起",
    "tenantName": "思晨教育",
    "ordinal": true,
    "category": {
      "id": "3053202902198805409",
      "name": "自动化测试-勿动zxs"
    },
    "creator": {
      "name": "韩军超",
      "contact": "18663049557",
      "contactType": "MOBILE"
    },
    "status": "DRAFT",
    "expireTime": "2023-02-17 15:17:06",
    "signatories": [
      {
        "id": "3053227768113266811",
        "tenantType": "COMPANY",
        "status": "DRAFT",
        "tenantName": "思晨教育",
        "receiver": {
          "name": "韩军超",
          "contact": "18663049557",
          "contactType": "MOBILE"
        },
        "serialNo": 0,
        "actions": [
          {
            "id": "3053227768201347196",
            "type": "AUDIT",
            "status": "INIT",
            "name": "审批动作",
            "serialNo": 0,
            "autoSign": false,
            "operators": [
              {
                "contact": "18663049557",
                "contactType": "MOBILE"
              }
            ]
          },
          {
            "id": "3053227768226513022",
            "type": "LP",
            "status": "INIT",
            "name": "法人签署动作",
            "serialNo": 1,
            "autoSign": false
          },
          {
            "id": "3053227768289427583",
            "type": "COMPANY",
            "status": "INIT",
            "name": "公章签署动作",
            "serialNo": 2,
            "autoSign": false,
            "operators": [
              {
                "contact": "18663049557",
                "contactType": "MOBILE"
              }
            ]
          }
        ],
        "delaySet": false,
        "sponsor": true
      },
      {
        "id": "3053227768331370625",
        "tenantType": "PERSONAL",
        "status": "DRAFT",
        "tenantName": "韩军超",
        "receiver": {
          "contact": "18663049557",
          "contactType": "MOBILE"
        },
        "serialNo": 1,
        "delaySet": false,
        "sponsor": false
      }
    ]
  },
  "code": 0,
  "message": "SUCCESS"
}