Anexos do contrato
Anexos são arquivos complementares do contrato, como a proposta comercial ou o termo de distrato assinado. Eles não passam pela leitura automática. O contrato precisa estar em pending_submission, active ou expired.
Para incluir um anexo:
- Crie o anexo.
- Obtenha a URL de envio do anexo.
- Envie o arquivo direto para essa URL.
Para baixar o arquivo, use attachments[].download_url na consulta do contrato.
Criar anexo
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Criar Contratos de Despesa |
URL base de cada host: Ambientes (Hosts).
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
fund_class_key | string | Chave da classe de fundo (UUID). |
contract_key | string | Chave do contrato (UUID). |
Esta chamada não leva corpo.
Resposta
{
"attachment_key": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"status": "active",
"created_at": "2026-11-09T14:20:11.004512"
}
| Campo | Tipo | Descrição |
|---|---|---|
attachment_key | string | Chave do anexo (UUID). |
status | string | active desde a criação; canceled depois do cancelamento. |
created_at | string | Criação, ISO 8601 sem fuso. |
Obter URL de envio do anexo
Permissão: Gestora (manager-api): Escrita. Consultoria (consultant-api): Criar Contratos de Despesa.
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
fund_class_key | string | Chave da classe de fundo (UUID). |
contract_key | string | Chave do contrato (UUID). |
attachment_key | string | Chave do anexo (UUID). |
Resposta
{
"attachment_key": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"status": "active",
"created_at": "2026-11-09T14:20:11.004512",
"upload_url": {
"url": "https://<link-temporario-de-envio>",
"fields": {
"key": "3f2b8c1e-7d4a-4e9b-9a61-0c5d2e8f4b17/d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"policy": "<policy>",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-credential": "<credential>",
"x-amz-date": "20261109T142100Z",
"x-amz-signature": "<signature>"
}
}
}
Envie o arquivo como no documento do contrato: POST multipart/form-data para upload_url.url, com todos os campos de upload_url.fields e o arquivo no campo file. A URL expira em 3 minutos e aceita arquivos de até 50 MB.
Um novo envio substitui o arquivo do anexo. Não há chamada de confirmação.
Cancelar anexo
Marca o anexo como canceled. Cancelar um anexo já cancelado não tem efeito.
Permissão: Gestora (manager-api): Escrita. Consultoria (consultant-api): Atualizar Contratos de Despesa.
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
fund_class_key | string | Chave da classe de fundo (UUID). |
contract_key | string | Chave do contrato (UUID). |
attachment_key | string | Chave do anexo (UUID). |
Resposta
Sem corpo na resposta.
Erros
| Status | code | Quando acontece |
|---|---|---|
| 404 | ECT000005 | A classe de fundo não existe ou você não tem acesso a ela. |
| 404 | ECT000009 | O contrato não existe nessa classe de fundo. |
| 404 | ECT000050 | O anexo não existe neste contrato. |
| 409 | ECT000048 | O contrato não está em pending_submission, active nem expired. |
{
"title": "Attachment not allowed",
"description": "Attachments are not handled on a contract in status canceled.",
"translation": "Anexos nao sao tratados num contrato com status canceled.",
"code": "ECT000048"
}
Erros de autenticação, permissão e host: veja Erros da API.