Contract manipulation
Depending on the flow, it may be necessary to make some calls to complete the flow of a contract.
Manager Approval
If the contract is proposed by a consultant, after the documents are generated, the manager's approval is required before it is sent for signature. Only the manager approves or rejects: the consultant accesses the same endpoint, but only to cancel.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read and write |
| Consultant | consultant-api | Create assignment contracts |
Base URL for each host: Environments (Hosts).
Request
{
"status": "denied",
"denial_reason": "Insufficient assignor documentation"
}
Body Params
| Field | Type | Description | Characters |
|---|---|---|---|
status * | string | Manager's decision: approved or denied. | -- |
denial_reason | string | Description of the reason for the rejection. Returned in the denied status webhook. | Up to 500 |
*Required fields
Response
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ACT000023 | assignment_contract_key not found. |
| 400 | ACT000025 | Approval or rejection sent by someone other than the manager. |
| 400 | ACT000077 | The current status does not allow the decision. approved requires pending_manager_approval; denied accepts pending_manager_approval or pending_document. |
Authentication, permission and host errors: see API errors.
Manual Signature Submission
If the template configures manual submission for signature, it is possible to group several contracts, as long as they have the same manager, assignor and guarantors, into the same signature batch. Every contract in the batch must be in pending_signature_submission.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
Base URL for each host: Environments (Hosts).
Request
{
"assignment_contract_keys": [
"1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"41d6ff41-1dac-4df7-9e50-d15210ec57f3"
]
}
Body Params
| Field | Type | Description | Characters |
|---|---|---|---|
assignment_contract_keys * | array | List of contracts to be sent in the same batch | -- |
*Required fields
Response
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ACT000023 | One of the keys in assignment_contract_keys was not found. |
| 400 | ACT000088 | One of the contracts is not in pending_signature_submission. |
| 404 | ACT000089 | The contracts in the batch do not have the same related parties (manager, assignor, guarantors). Only group contracts with the same parties. |
| 400 | ACT000165 | Every contract in the batch comes from templates that forbid standalone signature. Include at least one contract that allows it. |
Authentication, permission and host errors: see API errors.
Contract Cancellation
At any stage, except when the contract is already signed, it is possible to cancel it. If it is under signature, the signature event is also canceled.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read and write |
| Consultant | consultant-api | Create assignment contracts |
Base URL for each host: Environments (Hosts).
Request
{
"status": "canceled"
}
Body Params
| Field | Type | Description | Characters |
|---|---|---|---|
status * | string | canceled | -- |
*Required fields
Response
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ACT000023 | assignment_contract_key not found. |
| 400 | ACT000077 | The contract is signed or denied and cannot be canceled. |
Authentication, permission and host errors: see API errors.