跳到主要内容

合同操作

根据流程的不同，可能需要进行一些调用才能完成合同流程。

管理人审批​

如果合同由顾问提出，在生成文件之后、发送签署之前，需要管理人审批。只有管理人可以审批通过或拒绝：顾问可以访问同一路由，但仅用于取消。

适用范围
角色主机所需权限
管理人manager-api读取和写入
顾问consultant-apiCreate assignment contracts

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY
MÉTODO
PUT
Request Body
{
    "status": "denied",
    "denial_reason": "Documentação do cedente insuficiente"
}

Body Params​

字段类型描述字符数
status *string管理人的决定：approved 或 denied。--
denial_reasonstring拒绝原因的说明。会在 denied 状态的 webhook 中返回。最多 500

*必填字段

Response​

STATUS
202

错误​

状态码代码触发条件
404ACT000023未找到 assignment_contract_key。
400ACT000025审批通过或拒绝由非管理人发送。
400ACT000077当前状态不允许该决定。approved 要求 pending_manager_approval；denied 接受 pending_manager_approval 或 pending_document。

认证、权限和主机相关错误：参见 API 错误。

手动发送签署​

如果模板配置为手动发送签署，可以将多份合同归入同一个签署批次，前提是这些合同的管理人、转让方和担保人相同。批次中的所有合同都必须处于 pending_signature_submission。

适用范围
角色主机所需权限
管理人manager-api写入

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/assignment_contract/signature_batch
MÉTODO
POST
Request Body
{
    "assignment_contract_keys": [
        "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
        "41d6ff41-1dac-4df7-9e50-d15210ec57f3"
    ]
}

Body Params​

字段类型描述字符数
assignment_contract_keys *array要在同一批次中发送的合同列表--

*必填字段

Response​

STATUS
202

错误​

状态码代码触发条件
404ACT000023未找到 assignment_contract_keys 中的某个 key。
400ACT000088其中一份合同不处于 pending_signature_submission。
404ACT000089批次中的合同关联方（管理人、转让方、担保人）不相同。请只将关联方相同的合同归为一组。
400ACT000165批次中的所有合同均来自禁止单独签署的模板。请至少包含一份允许单独签署的合同。

认证、权限和主机相关错误：参见 API 错误。

取消合同​

除已签署的合同外，在任何阶段都可以取消合同。如果合同正在签署中，签署事件也会被取消。

适用范围
角色主机所需权限
管理人manager-api读取和写入
顾问consultant-apiCreate assignment contracts

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY
MÉTODO
PUT
Request Body
{
    "status": "canceled"
}

Body Params​

字段类型描述字符数
status *stringcanceled--

*必填字段

Response​

STATUS
202

错误​

状态码代码触发条件
404ACT000023未找到 assignment_contract_key。
400ACT000077合同处于 signed 或 denied，无法取消。

认证、权限和主机相关错误：参见 API 错误。