签署服务-撤回/作废合同

POST

/v2/contract/invalid

调用此接口撤回已发起的合同或者作废已完成的合同。
合同是“草稿”、“已过期”、“已撤回”、“已退回”状态时，删除合同；
合同是“签署中”状态时，撤回合同，合同变为“已撤回”状态；
合同是“已完成”状态时，作废合同（作废合同需要所有签署方签署作废文件后，作废完成），同时在作废文件上签署发起方公章。作废文件由契约锁自动生成。

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

contractId

string

合同ID

可选

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

bizId

string

业务ID

可选

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

tenantName

string

子公司名称

可选

若使用业务ID撤回作废合同，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

sealId

string

印章ID

可选

发起方签署作废文件时指定的印章，作废合同时使用。若发起方已签署，不传默认取发起方印章ID

reason

string

撤回/作废原因

可选

deleteDoc

boolean

作废完成后或撤回后是否删除合同文件

可选

默认false

autoSign

boolean

发起作废时是否自动签署作废文件

可选

默认true

receivers

array[object (CopySendReceiverRequest) {4}]

作废通知接收人

可选

仅单方作废时生效；传入的参数里联系方式重复，以第一条为准

name

string

抄送人姓名

必需

receiver

object

抄送人联系方式

必需

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

createTime

string

创建时间

可选

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

send

string

是否已经抄送

可选

示例

{
  "receivers": [
    {
      "name": "类导从",
      "receiver": {
        "contact": "consequat dolor sunt",
        "contactType": "ipsum reprehenderit aliqua ex Ut",
        "name": "南少声年进斯"
      },
      "createTime": "1993-10-27 15:25:45",
      "send": "eiusmod laboris labore"
    }
  ],
  "bizId": "70",
  "tenantName": "海华可院太",
  "deleteDoc": false,
  "reason": "in minim",
  "autoSign": false,
  "sealId": "18",
  "contractId": "1304147838782070"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/invalid' \
--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 '{
    "receivers": [
        {
            "name": "类导从",
            "receiver": {
                "contact": "consequat dolor sunt",
                "contactType": "ipsum reprehenderit aliqua ex Ut",
                "name": "南少声年进斯"
            },
            "createTime": "1993-10-27 15:25:45",
            "send": "eiusmod laboris labore"
        }
    ],
    "bizId": "70",
    "tenantName": "海华可院太",
    "deleteDoc": false,
    "reason": "in minim",
    "autoSign": false,
    "sealId": "18",
    "contractId": "1304147838782070"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
  "code": 0,
  "message": "SUCCESS"
}

签署服务-获取短链接

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