契约锁 API
  1. 签署服务
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
      • 合同管理-用文件添加合同文档
      • 合同管理-多文件添加合同文档
      • 合同管理-用模板添加合同文档
      • 合同管理-发起合同
      • 合同管理-抄送合同
      • 合同管理-修改签署方
      • 合同管理-添加签署方
      • 合同管理-浏览页面
      • 合同管理-合同详情
      • 合同管理-获取合同列表
      • 合同管理-下载合同与附属文件
      • 合同管理-下载合同文档
      • 合同管理-强制结束合同
      • 合同管理-上传强制结束附件
      • 合同管理-合同文档添加水印
      • 合同管理-合同延期
      • 合同管理-获取合同操作记录
      • 合同管理-获取合同与附属文件下载链接
    • 签署服务
      • 签署服务-公章签署
        POST
      • 签署服务-签署法人章
        POST
      • 签署服务-审批
        POST
      • 签署服务-合同催签
        POST
      • 签署服务-签署页面
        POST
      • 签署服务-预签署页面
        POST
      • 签署服务-获取短链接
        GET
      • 签署服务-撤回/作废合同
        POST
      • 签署服务-自定义文件作废合同
        POST
      • 签署服务-自定义模板文件作废合同
        POST
      • 签署服务-签署作废合同
        POST
      • 签署服务-签署个人签名
        POST
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
      • 模板管理-模板详情
      • 模板管理-模版预览页面
      • 模板管理-创建Word模板
      • 模板管理-编辑模板
      • 模板管理-管理模板状态
      • 模板管理-下载模板
      • 模板管理-删除模板
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 签署服务

签署服务-自定义模板文件作废合同

POST
/v2/contract/invalidbytemplate
使用模板生成作废文件,发起作废合同。发起作废的合同需要所有签署方签署作废文件后,作废完成。

请求参数

Header 参数
x-qys-open-accesstoken
string 
可选
默认值:
{{x-qys-open-accesstoken}}
x-qys-open-timestamp
string 
可选
默认值:
{{x-qys-open-timestamp}}
x-qys-open-nonce
string 
可选
默认值:
{{x-qys-open-nonce}}
x-qys-open-signature
string 
可选
默认值:
{{x-qys-open-signature}}
Body 参数application/json
contractId
string 
合同ID
可选
合同ID与业务ID二选一,不能同时为空
bizId
string 
业务ID
可选
合同ID与业务ID二选一,不能同时为空
tenantName
string 
子公司名称
可选
若使用业务ID撤回作废合同,且合同是以子公司身份创建的,则需要传递该值,用于确定合同主体
templateId
string 
模板ID
必需
templateParams
array[object (TemplateParamRequest) {7}] 
模板参数
可选
如果是参数模板,则必填(支持格式为文本、单选框、多选框格式的参数)
name
string 
要修改的参数名称
必需
required
boolean 
设置参数是否必填
可选
defaultValue
string 
设置参数默认值
可选
单选多选不支持设置默认值,时间格式默认值需以'yyyy-MM-dd'格式提供
description
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时,在页面上进行合同填参时该参数不可编辑
signatoryId
string 
参数填写方
可选
title
string 
自定义作废文件名称
必需
deleteDoc
boolean 
作废完成后或撤回后是否删除合同文件
可选
默认false
invalidReason
string 
作废原因
可选
stampers
array[object (InvalidStamperBeanRequest) {8}] 
指定签署位置
可选
signatoryId
number 
签署方ID
必需
type
enum<string> 
签署类型
必需
COMPANY(公章),PERSONAL(个人签名) , TIMESTAMP(时间戳)
枚举值:
COMPANYPERSONALTIMESTAMP
keyword
string 
关键字
可选
keywordIndex
integer 
关键字索引
可选
1代表第1个关键字, 0代表所有关键字,-1代表倒数第1个关键字;默认为1
page
integer 
坐标页码
可选
0代表所有
offsetX
string 
横坐标/关键字偏移量
可选
offsetY
string 
纵坐标/关键字偏移量
可选
datePatterns
array[string]
时间戳格式
可选
HYPHEN(yyyy-mm-dd),Chinese(yyyy年mm月dd日(阿拉伯数字)),ALL_Chinese(yyyy年mm月dd日(中文));仅type为TIMESTAMP时生效,可指定多个格式
枚举值:
HYPHENChineseALL_Chinese
示例
{
  "templateId": "42",
  "title": "价而史气带",
  "bizId": "45",
  "contractId": "85",
  "stampers": [
    {
      "signatoryId": 74,
      "type": "COMPANY",
      "keyword": "Duis culpa elit id",
      "keywordIndex": 12,
      "datePatterns": [
        "HYPHEN",
        "Chinese",
        "HYPHEN"
      ],
      "offsetX": "et consequat commodo",
      "offsetY\t": "mollit exercitation sed",
      "page": 2
    },
    {
      "signatoryId": 84,
      "type": "COMPANY",
      "page": 17,
      "offsetY\t": "magna dolor",
      "datePatterns": [
        "HYPHEN",
        "Chinese",
        "Chinese",
        "HYPHEN",
        "Chinese"
      ],
      "keywordIndex": 57,
      "offsetX": "officia velit",
      "keyword": "ad incididunt aliquip elit velit"
    },
    {
      "signatoryId": 58,
      "type": "PERSONAL",
      "keyword": "dolor culpa aliquip nulla qui",
      "offsetY\t": "laboris ea",
      "offsetX": "ullamco",
      "datePatterns": [
        "ALL_Chinese",
        "HYPHEN",
        "ALL_Chinese"
      ],
      "page": 73,
      "keywordIndex": 58
    }
  ],
  "templateParams": [
    {
      "name": "业除书酸外",
      "value": "dolore sit non proident officia",
      "signatoryId": "10",
      "description": "及方去海阶求区他家海共比程。际定石干头点更与非要个周主。文族无者火土将基年物历量素半青意程。马除道则我引机再且济界任打海。口广立三毛按和报比至体省解叫去院。非华本上利重会局月明交须效眼。",
      "readOnly": "id do labore ullamco",
      "required": false,
      "defaultValue": "ex amet occaecat enim"
    },
    {
      "name": "原千花人务",
      "value": "cillum",
      "readOnly": "proident sed voluptate consequat Excepteur",
      "description": "地调不者济平他直们效对斗已单法。院金权论代指被图济程都已便。型矿命日每一六八集它基当本儿前。细素行性场压线元消器列么。日收那教月金从除器技部量。者程界进连美习容政消节问积习府。",
      "defaultValue": "ipsum",
      "signatoryId": "31",
      "required": true
    },
    {
      "name": "保热系放期维标",
      "value": "exercitation in commodo",
      "readOnly": "exercitation amet officia velit Duis",
      "required": true,
      "defaultValue": "esse tempor Duis consequat culpa",
      "description": "放开化很基区只品这到去所战片电问阶具。她最代王识走把养往他劳它已心队今。她高己间党转军值几真方省天型而东约科。争复联结亲王身至标许群京任展然如。满导件于们制间机转办情育。被太关战最层万解情比验原开所半先。",
      "signatoryId": "45"
    }
  ],
  "tenantName": "类格产",
  "deleteDoc": false,
  "invalidReason": "65"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/invalidbytemplate' \
--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 '{
    "templateId": "42",
    "title": "价而史气带",
    "bizId": "45",
    "contractId": "85",
    "stampers": [
        {
            "signatoryId": 74,
            "type": "COMPANY",
            "keyword": "Duis culpa elit id",
            "keywordIndex": 12,
            "datePatterns": [
                "HYPHEN",
                "Chinese",
                "HYPHEN"
            ],
            "offsetX": "et consequat commodo",
            "offsetY\t": "mollit exercitation sed",
            "page": 2
        },
        {
            "signatoryId": 84,
            "type": "COMPANY",
            "page": 17,
            "offsetY\t": "magna dolor",
            "datePatterns": [
                "HYPHEN",
                "Chinese",
                "Chinese",
                "HYPHEN",
                "Chinese"
            ],
            "keywordIndex": 57,
            "offsetX": "officia velit",
            "keyword": "ad incididunt aliquip elit velit"
        },
        {
            "signatoryId": 58,
            "type": "PERSONAL",
            "keyword": "dolor culpa aliquip nulla qui",
            "offsetY\t": "laboris ea",
            "offsetX": "ullamco",
            "datePatterns": [
                "ALL_Chinese",
                "HYPHEN",
                "ALL_Chinese"
            ],
            "page": 73,
            "keywordIndex": 58
        }
    ],
    "templateParams": [
        {
            "name": "业除书酸外",
            "value": "dolore sit non proident officia",
            "signatoryId": "10",
            "description": "及方去海阶求区他家海共比程。际定石干头点更与非要个周主。文族无者火土将基年物历量素半青意程。马除道则我引机再且济界任打海。口广立三毛按和报比至体省解叫去院。非华本上利重会局月明交须效眼。",
            "readOnly": "id do labore ullamco",
            "required": false,
            "defaultValue": "ex amet occaecat enim"
        },
        {
            "name": "原千花人务",
            "value": "cillum",
            "readOnly": "proident sed voluptate consequat Excepteur",
            "description": "地调不者济平他直们效对斗已单法。院金权论代指被图济程都已便。型矿命日每一六八集它基当本儿前。细素行性场压线元消器列么。日收那教月金从除器技部量。者程界进连美习容政消节问积习府。",
            "defaultValue": "ipsum",
            "signatoryId": "31",
            "required": true
        },
        {
            "name": "保热系放期维标",
            "value": "exercitation in commodo",
            "readOnly": "exercitation amet officia velit Duis",
            "required": true,
            "defaultValue": "esse tempor Duis consequat culpa",
            "description": "放开化很基区只品这到去所战片电问阶具。她最代王识走把养往他劳它已心队今。她高己间党转军值几真方省天型而东约科。争复联结亲王身至标许群京任展然如。满导件于们制间机转办情育。被太关战最层万解情比验原开所半先。",
            "signatoryId": "45"
        }
    ],
    "tenantName": "类格产",
    "deleteDoc": false,
    "invalidReason": "65"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
result
object (ContractResponse) 
必需
id
string 
合同ID
可选
tenantName
string 
发起方名称
可选
subject
string 
合同主题(合同名称)
可选
description
string 
合同描述
可选
sn
string 
合同编号
可选
expireTime
string 
过期时间
可选
publishTime
string 
合同发起时间
可选
tags
array[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": "3053174206079459711",
    "subject": "接口发起",
    "description": "合同描述",
    "tenantName": "思晨教育",
    "ordinal": true,
    "status": "INVALIDING",
    "expireTime": "2023-02-17 11:44:24",
    "publishTime": "2023-01-18 11:44:17"
  },
  "code": 0,
  "message": "SUCCESS"
}
上一页
签署服务-自定义文件作废合同
下一页
签署服务-签署作废合同
Built with