Manipulação de contrato
Dependendo do fluxo, pode ser necessário realizar algumas chamadas para concluir o fluxo de um contrato.
Aprovação do Gestor
Caso o contrato seja proposto por uma consultoria, após a geração dos documentos, será necessária a aprovação do gestor, antes que o mesmo seja enviado para assinatura. Só a gestora aprova ou recusa: a consultoria acessa a mesma rota, mas apenas para cancelar.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura e escrita |
| Consultoria | consultant-api | Criar contratos de cessão |
URL base de cada host: Ambientes (Hosts).
Request
{
"status": "denied",
"denial_reason": "Documentação do cedente insuficiente"
}
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
status * | string | Decisão do Gestor: approved ou denied. | -- |
denial_reason | string | Descritivo com o motivo da recusa. Volta no webhook do status denied. | Até 500 |
*Campos obrigatórios
Response
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ACT000023 | assignment_contract_key não encontrado. |
| 400 | ACT000025 | Aprovação ou recusa enviada por quem não é a gestora. |
| 400 | ACT000077 | O status atual não permite a decisão. approved exige pending_manager_approval; denied aceita pending_manager_approval ou pending_document. |
Erros de autenticação, permissão e host: veja Erros da API.
Envio para Assinatura Manual
Caso o template configure envio manual para assinatura, é possível agrupar vários contratos, desde que os mesmos tenham o mesmo gestor, cedente e avalistas, para um mesmo lote de assinaturas. Todos os contratos do lote precisam estar em pending_signature_submission.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
URL base de cada host: Ambientes (Hosts).
Request
{
"assignment_contract_keys": [
"1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"41d6ff41-1dac-4df7-9e50-d15210ec57f3"
]
}
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
assignment_contract_keys * | array | Lista de contratos para serem enviados no mesmo lote | -- |
*Campos obrigatórios
Response
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ACT000023 | Uma das chaves de assignment_contract_keys não foi encontrada. |
| 400 | ACT000088 | Um dos contratos não está em pending_signature_submission. |
| 404 | ACT000089 | Os contratos do lote não têm as mesmas partes relacionadas (gestor, cedente, avalistas). Agrupe só contratos com as mesmas partes. |
| 400 | ACT000165 | Todos os contratos do lote são de templates que proíbem assinatura isolada. Inclua ao menos um contrato que a permita. |
Erros de autenticação, permissão e host: veja Erros da API.
Cancelamento de Contrato
Em qualquer etapa, menos no caso de um contrato já assinado, é possível cancelar o mesmo. Caso esteja em assinatura, o evento de assinaturas também é cancelado.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura e escrita |
| Consultoria | consultant-api | Criar contratos de cessão |
URL base de cada host: Ambientes (Hosts).
Request
{
"status": "canceled"
}
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
status * | string | canceled | -- |
*Campos obrigatórios
Response
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ACT000023 | assignment_contract_key não encontrado. |
| 400 | ACT000077 | O contrato está signed ou denied e não pode ser cancelado. |
Erros de autenticação, permissão e host: veja Erros da API.