Edição do contrato
Corrige os dados de um contrato ainda em pending_submission. Só os campos enviados mudam.
- Para trocar o PDF, envie um novo documento.
- O fornecedor não pode ser trocado. Para usar outro fornecedor, cancele o contrato e crie outro.
Editar contrato
Disponível em
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Atualizar Contratos de Despesa |
URL base de cada host: Ambientes (Hosts).
ENDPOINT
/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/contract_dataMÉTODO
PUTParâ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). |
Corpo da requisição
{
"expense_types": [
{
"expense_type": "audit_tax"
},
{
"expense_type": "lawyer_fee"
}
],
"recurrences": null,
"expiration_date": "2028-06-30"
}
Atributos do corpo
Envie pelo menos um campo. Cada campo segue as regras da criação.
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Novo nome, de 1 a 255 caracteres. |
signature_method | string | certifiqi, qi_sign ou external. |
expense_types | array | Substitui todos os tipos de despesa. Se recurrences não vier na mesma chamada, as recorrências atuais precisam continuar cobrindo exatamente os novos tipos. |
recurrences | array | Substitui todas as recorrências. null remove todas. |
expiration_date | string | Novo vencimento, YYYY-MM-DD. null remove o vencimento. |
Resposta
STATUS
200O contrato atualizado, na estrutura descrita em atributos do contrato. Recorrências removidas continuam em parametrizations, com status: canceled.
Erros
| Status | code | Quando acontece |
|---|---|---|
| 400 | QIT000001 | Corpo vazio ({}) ou inválido. |
| 400 | ECT000040 | expiration_date não é uma data válida. |
| 400 | ECT000012, ECT000010 | Um tipo de despesa não existe, não usa contrato ou é contratado na estruturação do fundo. |
| 400 | ECT000061, ECT000045 | Uma recorrência tem end_date anterior a start_date, ou as recorrências não têm exatamente uma para cada tipo de despesa. |
| 400 | ECT000060 | Num aditivo, os tipos de despesa não são exatamente os do contrato original. |
| 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. |
| 409 | ECT000017 | O contrato não está em pending_submission. Depois do envio para análise, os dados não mudam. |
| 409 | ECT000046 | O contrato foi criado pela QI Tech na estruturação do fundo e não aceita esta chamada. |
| 409 | ECT000014 | Um dos novos tipos já está em outro contrato em andamento, active ou expired deste fundo com este fornecedor. |
Exemplo
{
"title": "Contract not pending submission",
"description": "This action requires a contract in status pending_submission, not sent_to_analysis.",
"translation": "Esta acao exige um contrato com status pending_submission, nao sent_to_analysis.",
"code": "ECT000017"
}
Erros de autenticação, permissão e host: veja Erros da API.