Consulta de Posições em Cotas de Fundo
Este recurso está disponível apenas para integrações que exercem o papel de Gestor.
Retorna, para cada fundo investido, quanto o seu fundo tem aplicado: o valor atualizado da posição em reais, a quantidade de cotas e a data da última marcação. Diferente da consulta de aplicações financeiras, que lista operação por operação, aqui a resposta já vem consolidada por série de emissão do fundo investido.
É a consulta indicada para saber o saldo aplicado em um fundo de zeragem — veja Consultando a posição em um fundo de zeragem.
Request
Onde FUND_CLASS_KEY é a chave da sua classe de fundo, aquela que detém as cotas.
Query Params
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
page | int | Número da página. Começa em 0. Padrão: 0. | Não |
limit | int | Quantidade de registros por página. Máximo: 50. Padrão: 10. | Não |
document_number | string | CNPJ da classe do fundo investido, com pontuação. Correspondência exata. | Não |
internal_code | string | Código interno da série investida. Correspondência parcial. | Não |
internal_codes | lista | Lista de códigos internos. Correspondência exata. | Não |
fund_class_name | string | Nome da classe do fundo investido. Correspondência parcial. | Não |
subclass_name | lista | Senioridade da subclasse investida: senior, mezzanine, subordinate. | Não |
investment_category | lista | Categoria do fundo investido: fidc, fiagro, multi_market, fixed_income, private_equity, equity, real_state. | Não |
asset_types | lista | Tipo do ativo: fidc_fund_quota, fiagro_fund_quota, multi_market_fund_quota, fixed_income_fund_quota, private_equity_fund_quota. | Não |
GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=64.289.387/0001-20
Somente posições em ativos ativos entram no resultado. Cotas totalmente resgatadas ou baixadas não aparecem.
Response
{
"data": [
{
"quota_fund_class": {
"name": "Série Única",
"quota_fund_class_key": "UUID",
"document_number": "00.000.000/0000-00",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class Short Name",
"investment_category": "fixed_income",
"tax_classification": "long_term",
"internal_code": "Internal Code",
"subclass_name": "senior",
"entity_category": "fund",
"fund_term_target": "undetermined",
"fund_regime": "open_ended",
"operation_periods": {
"redemption_request": {
"payment": { "days": 0, "type": "fixed", "calendar_base": "workdays" },
"quotation": { "days": 0, "type": "fixed", "calendar_base": "workdays" }
}
},
"isin_code": "BR000000000"
},
"total_current_value": 1234567.89,
"total_current_units": 1180000.0,
"last_mtm_date": "YYYY-MM-DD",
"lag": {
"reference": "daily",
"amount": 1
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
Response Fields
| Campo | Tipo | Descrição |
|---|---|---|
data | array | Lista de objetos de Posição |
limit | int | Limite de objetos recuperados por página |
page | int | Número da página recuperada |
is_last_page | boolean | Indica se a página recuperada é a última |
Posição
| Campo | Tipo | Descrição |
|---|---|---|
quota_fund_class | JSON | Objeto de Fundo investido |
total_current_value | float | Valor atualizado da posição, em reais. Soma do valor corrente dos ativos da série |
total_current_units | float | Quantidade atual de cotas detidas na série |
last_mtm_date | string | Data da marcação mais antiga entre as posições agregadas, no formato YYYY-MM-DD |
lag | JSON | Configuração de defasagem de precificação da série. Omitido quando a série não tem defasagem |
Diferente da API de Visibilidade de Caixa, onde os saldos vêm em centavos, aqui total_current_value é um número decimal em reais. Ex.: 1234.56 = R$ 1.234,56.
O last_mtm_date é o mínimo entre as datas de marcação das posições agregadas, e não a mais recente. Use-o para saber até quando o valor está garantidamente atualizado.
Fundo investido
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Nome da série de emissão investida |
quota_fund_class_key | string | Chave única da série de emissão investida |
document_number | string | CNPJ da classe do fundo investido |
fund_class_name | string | Nome da classe do fundo investido |
fund_class_short_name | string | Nome curto da classe do fundo investido |
investment_category | string | Categoria de investimento do fundo investido |
tax_classification | string | Classificação tributária do fundo investido |
internal_code | string | Código interno da série investida |
subclass_name | string | Senioridade da subclasse investida |
entity_category | string | Categoria da entidade investida |
fund_term_target | string | Prazo alvo do fundo investido |
fund_regime | string | Regime do fundo investido |
operation_periods | JSON | Prazos de cotização e liquidação das operações da série |
isin_code | string | Código ISIN da série. Omitido quando a série não tem ISIN cadastrado |
Consultando a posição em um fundo de zeragem
Fundos de zeragem são fundos de liquidez usados para aplicar o caixa ocioso da sua classe, com aplicação e resgate por débito automático. A operação é feita pelos endpoints de Criar Aplicação Financeira e Criar Pedido de Resgate, enviando o source_account_key.
Para consultar quanto a sua classe tem aplicado em um fundo de zeragem específico, filtre pelo CNPJ dele:
GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=64.289.387/0001-20
O total_current_value da resposta é o saldo aplicado, em reais, na data indicada por last_mtm_date.
Uma mesma classe de fundo investida pode ter mais de uma série de emissão. Nesse caso a resposta traz uma linha por série, todas com o mesmo document_number, e o saldo total no fundo é a soma dos total_current_value retornados.
Para conhecer o saldo em conta bancária — que é o caixa ainda não aplicado — use os endpoints de Visibilidade de Caixa.
Possíveis erros
Classe de fundo não encontrada
{
"title": " Fund Class not Found",
"description": "Fund Class with key {fund_class_key} was not found.",
"translation": "A Fund Class com chave {fund_class_key} não foi encontrado.",
"code": "WLT000001"
}
Gestor não encontrado
{
"title": "Not Found Manager",
"description": "Manager with the key {manager_key} was not found.",
"translation": "O gestor com a chave {manager_key} não foi encontrado.",
"code": "WLT000066"
}
Classe de fundo não pertence ao gestor da integração
{
"title": "Forbidden Agent",
"description": "The agent with agent key ({agent_key}) can't access this resource.",
"translation": "O agente com chave ({agent_key}) não pode acessar esse recurso.",
"code": "WLT000098"
}