Pular para o conteúdo principal

Consulta paginada de Aplicação Financeira

Lista as aplicações financeiras de um cotista ou de uma classe de fundo, com paginação.

Por cotista​

Retorna as aplicações financeiras de um cotista.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/quota/investor/INVESTOR_KEY/financial_applications
MÉTODO
GET
STATUS
200

Para a gestora, a consulta retorna apenas aplicações em fundos dela, e só de investidores aos quais ela está vinculada.

Query Params​

ParâmetroDescrição
pagePágina, a partir de 0 (default 0)
limitItens por página (default 20, máximo 500)
statusLista de Financial Application Status
typesLista de tipos: primary_market, secondary_market
issuance_serie_keyFiltra por série de emissão
quotation_dateData de cotização (yyyy-mm-dd)
fund_class_document_numberCNPJ da classe de fundo
application_from_datetimeAplicações com data/hora maior ou igual ao valor, no formato yyyy-mm-ddTHH:MM:SSZ (UTC)
application_to_datetimeAplicações com data/hora menor ou igual ao valor, no formato yyyy-mm-ddTHH:MM:SSZ (UTC)

Por classe de fundo​

Retorna as aplicações financeiras de uma classe de fundo da gestora, da mais recente para a mais antiga.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/quota/fund_class/FUND_CLASS_KEY/financial_applications
MÉTODO
GET
STATUS
200

Query Params​

ParâmetroDescrição
pagePágina, a partir de 0 (default 0)
limitItens por página (default 20, máximo 100)
statusLista de Financial Application Status
investor_nameParte do nome do investidor (sem diferenciar maiúsculas)
investor_document_numberCPF/CNPJ do investidor
quotation_dateData de cotização (yyyy-mm-dd)
application_from_datetimeAplicações com data/hora maior ou igual ao valor, no formato yyyy-mm-ddTHH:MM:SSZ (UTC)
application_to_datetimeAplicações com data/hora menor ou igual ao valor, no formato yyyy-mm-ddTHH:MM:SSZ (UTC)

limit acima do máximo devolve 400.

Response​

As duas consultas devolvem a mesma estrutura. Cada item de data é o objeto Financial Application descrito em Consultar Aplicação Financeira por chave.

{
"data": [
{
"financial_application_key": "UUID",
"share_capital": 1000.0,
"status": "quoted",
"financial_application_type": "primary_market",
"quotation_date": "2025-01-10"
}
],
"limit": 20,
"page": 0,
"is_last_page": true
}
CampoTipoDescrição
dataarrayLista de aplicações financeiras
limitintItens por página
pageintPágina retornada
is_last_pagebooleantrue quando não há mais páginas

Erros​

StatusCódigoQuando acontece
400QIT000001Data ou data/hora em formato inválido
400QIT000004A gestora não é a gestora do fundo ou não está vinculada ao investidor
404QTA000002Classe de fundo não encontrada (consulta por classe)

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