- 平台简介
- 新手指南
- API协议
- API文档
- 合同管理
- 签署服务
- 组织架构
- 印章管理
- 模板管理
- 业务分类
- 个人认证
- 企业认证
- 外部客户
- 授权管理
- 辅助工具
- 信息校验
- 单点登录集成
- JS SDK文档
- 公告
- 小程序插件
- 常见问题
签署服务-自定义模板文件作废合同
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
bizId
string
业务ID
tenantName
string
子公司名称
templateId
string
模板ID
templateParams
array[object (TemplateParamRequest) {7}]
模板参数
name
string
要修改的参数名称
required
boolean
设置参数是否必填
defaultValue
string
设置参数默认值
description
string
设置参数描述值
value
string
文档参数值
readOnly
string
参数是否只读
signatoryId
string
参数填写方
title
string
自定义作废文件名称
deleteDoc
boolean
作废完成后或撤回后是否删除合同文件
invalidReason
string
作废原因
stampers
array[object (InvalidStamperBeanRequest) {8}]
指定签署位置
signatoryId
number
签署方ID
type
enum<string>
签署类型
枚举值:
COMPANYPERSONALTIMESTAMP
keyword
string
关键字
keywordIndex
integer
关键字索引
page
integer
坐标页码
offsetX
string
横坐标/关键字偏移量
offsetY
string
纵 坐标/关键字偏移量
datePatterns
array[string]
时间戳格式
枚举值:
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
接收方签署策略
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"
}