契约锁 API

合同管理-强制结束合同

POST

/v2/contract/forceend

请求参数

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强制结束合同，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

reason

string

强制结束原因

必需

示例

{
  "contractId": "{{contractIdAdd}}",
  "reason": "强制结束签署测试"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/forceend' \
--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 '{
    "contractId": "{{contractIdAdd}}",
    "reason": "强制结束签署测试"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

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

合同管理-下载合同文档

合同管理-上传强制结束附件