契约锁 API

合同管理-发起合同

POST

/v2/contract/send

调用此接口发起草稿状态的合同。支持在发起合同时指定签署位置。合同发起后，签署方将收到签署通知签署合同。

请求参数

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

stampers

array[object (StampersRequest) {10}]

指定签署位置

可选

actionId

string

签署节点ID

可选

公司的签署位置必须（创建合同草稿接口的返回值）

signatoryId

string

签署方ID

可选

个人的签署位置必传（创建合同草稿接口的返回值）

type

enum<string>

签署类型

必需

枚举值:

COMPANYPERSONALLPTIMESTAMPACROSS_PAGE

documentId

string

合同文档ID

必需

keyword

string

关键字

可选

keywordIndex

integer

关键字索引

可选

1代表第1个关键字，0代表所有关键字，-1代表倒数第1个关键字；默认为1

page

integer

坐标页码

可选

0代表所有 ,-1代表最后一页

offsetX

number

横坐标/关键字偏移量

可选

offsetY

number

坐标页码

可选

datePatterns

number

时间戳格式

可选

HYPHEN（yyyy-mm-dd），Chinese（yyyy年mm月dd日（阿拉伯数字）），ALL_Chinese（yyyy年mm月dd日（中文））；仅type为TIMESTAMP时生效，可指定多个格式

stamperRule

enum<string>

签署位置规则

可选

签署位置规则；MUST_FORBID（必须签署不可增加），MUST_ALLOW（必须签署可增加），OPTIONAL（非必须签署）；默认取业务分类中配置的规则

枚举值:

MUST_FORBIDMUST_ALLOWOPTIONAL

locateAllStamperKeywords

boolean

是否必须找出全部签署位置传入的关键字

可选

是否必须找出全部签署位置传入的关键字，默认为true；传入false时，对于传入的关键字定位的签署位置，只需定位到任意一个签署位置的关键字即可

示例

{
  "contractId": 2918350721957036000,
  "bizId": null,
  "tenantName": null,
  "stampers": [
    {
      "actionId": 2918350723236299000,
      "signatoryId": 2918350723223716000,
      "type": "COMPANY",
      "documentId": 2918350256934552000,
      "keyword": "放款通知书编号"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/send' \
--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": 2918350721957036080,
    "bizId": null,
    "tenantName": null,
    "stampers": [
        {
            "actionId": 2918350723236298803,
            "signatoryId": 2918350723223715890,
            "type": "COMPANY",
            "documentId": 2918350256934552124,
           
            "keyword": "放款通知书编号"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

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

合同管理-用模板添加合同文档

合同管理-抄送合同