Pular para o conteúdo principal

Despesas recorrentes

Uma despesa recorrente gera automaticamente uma despesa por período. Pela API, as recorrências só são consultadas. Elas vêm de dois lugares:

  • Contrato: nascem das recurrences do contrato de despesa quando ele entra em vigor.
  • QI Tech: as demais são cadastradas pela QI Tech.

Status da recorrência​

StatusDescrição
activeGerando despesas.
pending_approvalAguardando aprovação da QI Tech.
finishedChegou ao fim (end_date).
canceledEncerrada antes do fim.
reprovedReprovada pela QI Tech.

Listar despesas recorrentes​

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Despesas ou Ler Consolidações

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/expense/fund_class/{fund_class_key}/recurring_expenses
MÉTODO
GET

Parâmetros de consulta​

ParâmetroTipoObrigatórioDescrição
statusstringNãoUm status da recorrência.
expense_typestringNãoUm tipo de despesa.
contract_keystringNãoRecorrências de um contrato.
limitintegerNãoItens por página, de 0 a 100. Padrão: 10.
pageintegerNãoPágina, a partir de 0. Padrão: 0.

A lista vem da recorrência mais recente para a mais antiga.

STATUS
200
Corpo da resposta
{
"data": [
{
"recurring_expense_key": "a0b1c2d3-e4f5-4a6b-8c7d-9e0f1a2b3c4d",
"fund_class": {
"name": "FIDC EXEMPLO",
"manager": {
"name": "EXEMPLO GESTORA LTDA",
"manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"document_number": "22.333.444/0001-81"
},
"fund_class_key": "c1d2e3f4-a5b6-4789-abcd-ef1234567890",
"document_number": "33.444.555/0001-81",
"accounting_date": "2026-11-06"
},
"expense_type": "audit_tax",
"description": "Auditoria anual - parcela mensal",
"recurring_configuration_data": {
"expense_type": "audit_tax",
"description": "Auditoria anual - parcela mensal",
"amount": 2500.0,
"accrual": {
"accrual_system": "monthly"
},
"consolidated_by_manager": true,
"payment": {
"payment_reference": {
"reference_date": "end_date",
"workdays_only": true
},
"target": {
"document_number": "44.555.666/0001-81",
"name": "AUDITORES EXEMPLO S.A."
}
},
"start_date": "2027-01-01",
"end_date": "2027-12-31",
"contract_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57"
},
"amount": 2500.0,
"consolidated_by_manager": true,
"status": "active",
"contract_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57",
"start_date": "2027-01-01",
"end_date": "2027-12-31"
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
CampoDescrição
recurring_expense_keyChave da recorrência (UUID).
fund_classClasse de fundo, como na consulta de despesas.
expense_typeTipo das despesas geradas.
descriptionDescrição das despesas geradas.
recurring_configuration_dataConfiguração da recorrência como foi cadastrada. Ver abaixo.
amountValor de cada despesa.
consolidated_by_managertrue quando a gestora envia a nota fiscal de cada despesa gerada.
statusStatus da recorrência.
contract_key, vendor_keyContrato e fornecedor, ou null.
start_date, end_dateVigência, YYYY-MM-DD; end_date null sem fim.
disabled_atMomento do encerramento. Presente só em recorrências encerradas.

Configuração da recorrência​

Em recurring_configuration_data:

  • accrual define o período: accrual_system (monthly, bimonthly ou yearly) e start_month.
  • payment.payment_reference define a data de pagamento de cada despesa: reference_date (start_date ou end_date do período), workdays_only, days_after e months_after.
  • payment traz o favorecido e, nas recorrências sem contrato, o meio e o destino do pagamento.

Nas recorrências de contrato, cada despesa é paga ao fornecedor, na conta principal dele, no último dia útil do mês.

Consultar despesa recorrente​

Devolve uma recorrência e as despesas geradas por ela.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Despesas ou Ler Consolidações

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/expense/fund_class/{fund_class_key}/recurring_expense/{recurring_expense_key}
MÉTODO
GET

A resposta tem a estrutura da lista, com mais um campo: expenses, as despesas geradas pela recorrência (expense_key, status).

Erros​

StatuscodeQuando acontece
400EXP000069A classe de fundo não é da gestora.
403EXP000124A consultoria não tem vínculo ativo com o fundo. Normalmente o consultant-api recusa antes, com 401 (CIT000018).
404EXP000028A recorrência não existe no fundo.
500QIT000500limit ou page fora do intervalo ou não inteiro. A validação desses parâmetros chega como erro interno: corrija o parâmetro e repita a chamada.

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