Envio e cancelamento do contrato

Envia o contrato para a análise da QI Tech ou cancela um contrato em andamento.

O envio congela o documento e manda o contrato para a leitura automática e a análise da QI Tech. A partir daí, dados e documento não mudam: dá para acompanhar, cancelar e, em pending_signature, trocar a forma de assinatura.

Enviar para análise

Use depois de enviar o documento. O contrato precisa estar em pending_submission.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Criar Contratos de Despesa

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/submit

MÉTODO

PUT

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

STATUS

200

O contrato com status: sent_to_analysis e ai_analysis com status: sent, na estrutura descrita em atributos do contrato.

Trecho da resposta

{
    "contract_key": "3f2b8c1e-7d4a-4e9b-9a61-0c5d2e8f4b17",
    "status": "sent_to_analysis",
    "ai_analysis": {
        "ai_analysis_key": "7c8d9e0f-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
        "status": "sent",
        "analysis_result": null
    }
}

Depois do envio:

1. A leitura automática compara o documento com os dados do contrato: CNPJ do fundo e do fornecedor, tipos de despesa, vencimento, recorrências e cláusulas proibidas.
2. O contrato segue para in_manual_analysis, qualquer que seja o resultado da leitura.

Se a chamada devolver erro, o contrato continua em pending_submission.

Cancelar contrato

Cancela um contrato em andamento, ou seja, em um destes status: pending_submission, sent_to_analysis, in_manual_analysis, in_compliance_analysis, pending_manager_approval, pending_vendor_approval ou pending_signature. Em pending_signature, o lote de assinatura também é cancelado.

Um contrato active ou expired não pode ser cancelado: a gestora precisa pedir o distrato.

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}/cancel

MÉTODO

PUT

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

STATUS

200

O contrato com status: canceled. As recorrências ficam inactive.

Erros

Status	code	Quando acontece
400	ECT000071	Envio: não foi possível ler o documento. Envie de novo um PDF sem senha.
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	ECT000056	Envio: a leitura automática não está configurada na QI Tech. Acione o suporte.
409	ECT000017	Envio: o contrato não está em pending_submission.
409	ECT000022	Envio: o documento do contrato ainda não foi enviado.
409	ECT000015	Envio: o fornecedor está inactive.
409	ECT000059	Envio: o cadastro do fornecedor venceu (expired).
409	ECT000016	Cancelamento: o contrato não está em andamento. Um contrato active ou expired só é encerrado por distrato.
409	ECT000046	O contrato foi criado pela QI Tech na estruturação do fundo e não aceita esta chamada.

Exemplo

{
  "title": "Document not uploaded",
  "description": "The document of the contract 3f2b8c1e-7d4a-4e9b-9a61-0c5d2e8f4b17 was not uploaded.",
  "translation": "O documento do contrato 3f2b8c1e-7d4a-4e9b-9a61-0c5d2e8f4b17 nao foi enviado.",
  "code": "ECT000022"
}

Erros de autenticação, permissão e host: veja Erros da API.

Próximo passo

Consulta de contratos: acompanhe a análise e a assinatura.