Envio e cancelamento de despesa

Envia para análise uma despesa em pending_submission, ou cancela uma despesa que ainda não entrou na carteira do fundo. Só quem lançou a despesa, gestora ou consultoria, usa estas chamadas.

No envio, o status seguinte depende da provisão e do contrato. Para enviar já no lançamento, use submit: true no lançamento.

Enviar despesa

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Lançar e Editar Despesas ou Enviar Consolidações

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/expense/fund_class/{fund_class_key}/expense/{expense_key}/submit

MÉTODO

PUT

Parâmetros de caminho

Parâmetro	Tipo	Descrição
fund_class_key	string	Chave da classe de fundo (UUID).
expense_key	string	Chave da despesa (UUID).

Esta chamada não leva corpo.

Antes de enviar, confira:

• A memória de cálculo (calculation_memory) está entre os documentos da despesa ou da análise de consolidação.
• No reembolso, o comprovante de pagamento (payment_receipt) está na análise, se a nota fiscal (ou o boleto, nos tipos sem contrato) já foi enviada ou se o tipo é cvm_tax ou anbima_tax.
• A data de pagamento não passou.
• O contrato continua aceitando a despesa.

Resposta

STATUS

200

A despesa, na estrutura da consulta por chave, sem status_events e consolidation_status_events, no novo status:

Situação	Status da despesa
Sem provisão, contrato active ou sem contrato	pre_approved
Com provisão	in_manual_analysis
Sem provisão, contrato ainda em análise	pending_contract_analysis

Quando a despesa fica pre_approved ou in_manual_analysis, a análise de consolidação também vai para in_manual_analysis se:

• a nota fiscal já está entre os documentos da análise (nos tipos sem contrato, também o boleto, entre os documentos da despesa ou da análise); ou
• o tipo é cvm_tax ou anbima_tax.

Senão, envie a nota depois.

Cancelar despesa

Cancela a despesa e a análise de consolidação vigente. Vale nos status pending_submission, pending_contract_analysis, pre_approved, in_manual_analysis e pending_manager_approval. A API não cancela uma despesa que já entrou na carteira (de in_provision em diante).

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Lançar e Editar Despesas ou Enviar Consolidações

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/expense/fund_class/{fund_class_key}/expense/{expense_key}/cancel

MÉTODO

PUT

Esta chamada não leva corpo.

Resposta

STATUS

200

A despesa com status: canceled.

Erros

Status	code	Quando acontece
400	EXP000140	Envio: a despesa não está em pending_submission.
400	EXP000138	Envio: falta a memória de cálculo.
400	EXP000135	Envio: reembolso sem comprovante de pagamento, com a nota (ou o boleto, nos tipos sem contrato) já enviada ou com tipo cvm_tax ou anbima_tax.
400	EXP000121	Envio: a data de pagamento já passou. Cancele a despesa e lance outra com uma nova data.
400	EXP000126	Envio: o contrato não existe mais no fundo.
400	EXP000153	Envio: o contrato deixou de aceitar a despesa.
400	EXP000142	Cancelamento: a despesa não está em nenhum dos status em que o cancelamento vale.
400	EXP000069	A classe de fundo não é da gestora.
403	EXP000124	A consultoria não tem vínculo ativo com o fundo. Normalmente o consultant-api recusa antes, com 401 (CIT000018).
403	EXP000156	Você não lançou a despesa (permission_type diferente de owner).
404	EXP000010	A despesa não existe no fundo.
503	EXP000132	Envio: a API não conseguiu ler o contrato. Tente de novo.

Exemplo

{
  "title": "Calculation Memory Required",
  "description": "The expense requires a calculation_memory document to be submitted.",
  "translation": "A despesa exige o documento calculation_memory para ser enviada.",
  "code": "EXP000138"
}

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