契约锁 API

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

POST

/v2/contract/invalidbyfile

上传文件作为作废文件，发起作废合同。发起作废的合同需要所有签署方签署作废文件后，作废完成。

请求参数

Header 参数

Content-Type

string

必需

示例值:

multipart/form-data

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数multipart/form-data

invalidInfo

string

必需

作废相关信息invalidContractBean的json字符串

示例值:

{ "fileSuffix": "pdf", "stampers": [{ "type": "COMPANY", "signatoryId": 2931820895989203451, "offsetX": 0.5, "offsetY": 0.5, "page": 1 }], "contractId": 2931820895330697721, "title": "自定义作废文件1", "invalidReason": "cesss" }

file

自定义作废文件

必需

receivers

string

可选

作废通知接收人，抄送人列表List 的json数组字符串，仅单方作废时生效；传入的参数里联系方式重复，以第一条为准

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/invalidbyfile' \
--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: multipart/form-data' \
--form 'invalidInfo="{
    \"fileSuffix\": \"pdf\",
    \"stampers\": [{
        \"type\": \"COMPANY\",
        \"signatoryId\": 2931820895989203451,
        \"offsetX\": 0.5,
        \"offsetY\": 0.5,
        \"page\": 1
    }],
    \"contractId\": 2931820895330697721,
    \"title\": \"自定义作废文件1\",
    \"invalidReason\": \"cesss\"
}"' \
--form 'file=@""'

返回响应

🟢200成功

application/json

Body

result

object

必需

string

必需

subject

string

必需

description

string

必需

tenantName

string

必需

ordinal

boolean

必需

status

string

必需

expireTime

string

必需

publishTime

string

必需

code

integer

必需

message

string

必需

示例

{
  "result": {
    "id": "3053241682427380591",
    "subject": "接口发起1674029544239",
    "description": "合同描述",
    "tenantName": "思晨教育",
    "ordinal": true,
    "status": "INVALIDING",
    "expireTime": "2023-02-17 16:13:10",
    "publishTime": "2023-01-18 16:12:25"
  },
  "code": 0,
  "message": "SUCCESS"
}

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

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