Pular para o conteúdo principal

Edição do contrato

Corrige os dados de um contrato ainda em pending_submission. Só os campos enviados mudam.

Editar contrato​

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiEscrita
Consultoriaconsultant-apiAtualizar Contratos de Despesa

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/contract_data
MÉTODO
PUT

Parâmetros de caminho​

ParâmetroTipoDescrição
fund_class_keystringChave da classe de fundo (UUID).
contract_keystringChave 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.

CampoTipoDescrição
namestringNovo nome, de 1 a 255 caracteres.
signature_methodstringcertifiqi, qi_sign ou external.
expense_typesarraySubstitui todos os tipos de despesa. Se recurrences não vier na mesma chamada, as recorrências atuais precisam continuar cobrindo exatamente os novos tipos.
recurrencesarraySubstitui todas as recorrências. null remove todas.
expiration_datestringNovo vencimento, YYYY-MM-DD. null remove o vencimento.

Resposta​

STATUS
200

O contrato atualizado, na estrutura descrita em atributos do contrato. Recorrências removidas continuam em parametrizations, com status: canceled.

Erros​

StatuscodeQuando acontece
400QIT000001Corpo vazio ({}) ou inválido.
400ECT000040expiration_date não é uma data válida.
400ECT000012, ECT000010Um tipo de despesa não existe, não usa contrato ou é contratado na estruturação do fundo.
400ECT000061, ECT000045Uma recorrência tem end_date anterior a start_date, ou as recorrências não têm exatamente uma para cada tipo de despesa.
400ECT000060Num aditivo, os tipos de despesa não são exatamente os do contrato original.
404ECT000005A classe de fundo não existe ou você não tem acesso a ela.
404ECT000009O contrato não existe nessa classe de fundo.
409ECT000017O contrato não está em pending_submission. Depois do envio para análise, os dados não mudam.
409ECT000046O contrato foi criado pela QI Tech na estruturação do fundo e não aceita esta chamada.
409ECT000014Um 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.