Consulta paginada de Fechamento das Aplicações Financeiras

---

Requests

Requisição por classe de fundo

ENDPOINT

/quota/fund_class/FUND_CLASS_KEY/financial_application_closings

MÉTODO

GET

STATUS

200

Query Params

Parâmetro	Descrição
accounting_date	Data contábil específica de fechamento (formato yyyy-mm-dd)
from_date	Data de início do período (formato yyyy-mm-dd)
to_date	Data de fim do período (formato yyyy-mm-dd)
limit	Limite de objetos recuperados por página (mínimo 0, máximo 75, padrão 75)
page	Número da página recuperada (mínimo 0, padrão 0)

Atenção

É obrigatório enviar accounting_date ou a combinação de from_date e to_date. Caso nenhum desses parâmetros seja enviado, o recurso retornará erro de parâmetros obrigatórios ausentes.

Requisição por investidor e aplicação financeira

ENDPOINT

/quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY/financial_application_closings

MÉTODO

GET

STATUS

200

Query Params

Parâmetro	Descrição
last_financial_application_closing	Booleano. Quando true, retorna apenas o último fechamento da aplicação. Padrão: false.
limit	Limite de objetos recuperados por página (mínimo 0, máximo 500, padrão 50)
page	Número da página recuperada (mínimo 0, padrão 0)

Responses

Caso 01: Consulta bem-sucedida

{
    "data": [
        {
            "financial_application": {
                "financial_application_key": "UUID",
                "share_capital": 0.00,
                "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled",
                "investor": {
                    "investor_key": "UUID",
                    "name": "",
                    "person_type": "natural_person" | "legal_person",
                    "document_number": "999.999.999-99" | "99.999.999/9999-99",
                    "distributor": {
                        "distributor_key": "UUID",
                        "name": "",
                        "document_number": "99.999.999/9999-99",
                        "account_data": {}
                    }
                },
                "issuance_serie": {},
                "financial_application_type": "regular",
                "payment_method": "regular" | "cetip" | "b3",
                "quotation_date": "yyyy-mm-dd",
                "current_principal_value": 0.00000000,
                "current_number_of_quotas": 0.00000000,
                "original_number_of_quotas": 0.00000000,
                "original_number_of_quotas_str": "0.00000000",
                "acquisition_cost": 0.00,
                "external_id": "",
                "redemptions": [],
                "amortizations": [],
                "status_events": [],
                "reserved_taxable_yields": []
            },
            "total_value": 0.00,
            "number_of_quotas": 0.00000000,
            "principal_value": 0.00,
            "acquisition_cost": 0.00,
            "yield_value": 0.00,
            "ir_value": 0.00,
            "iof_value": 0.00,
            "taxable_yield_value": 0.00,
            "accounting_date": "yyyy-mm-dd"
        }
    ],
    "limit": 75,
    "page": 0,
    "is_last_page": true
}

Atenção

Os campos abaixo do objeto financial_application são condicionais — só são retornados quando o dado existe no recurso:

• redemptions[], amortizations[], status_events[], reserved_taxable_yields[]: listas omitidas quando vazias.
• original_number_of_quotas (e o sibling original_number_of_quotas_str), current_principal_value, acquisition_cost, current_number_of_quotas, quotation_date: preenchidos após o processamento de cotização da aplicação.
• payment_method, financial_application_type, external_id: opcionais por aplicação — retornados quando informados na criação ou em atualização posterior.

O envelope (data, limit, page, is_last_page) e os campos do objeto Financial Application Closing estão sempre presentes na resposta.

Page

Campo	Tipo	Descrição
data	array	Lista de objetos de Financial Application Closing
limit	int	Limite de objetos recuperados por página
page	int	Número da página recuperada
is_last_page	boolean	Informação que indica se a página recuperada é a última

Financial Application Closing

Campo	Tipo	Descrição
financial_application	JSON	Objeto de Financial Application
total_value	float	Valor total de fechamento da aplicação
number_of_quotas	float	Número de cotas referente ao fechamento
principal_value	float	Valor principal referente ao fechamento
acquisition_cost	float	Custo de aquisição das cotas relacionadas ao fechamento
yield_value	float	Valor do rendimento bruto
ir_value	float	Valor de IR
iof_value	float	Valor de IOF
taxable_yield_value	float	Valor do rendimento tributável
accounting_date	string	Data contábil referente ao fechamento da aplicação

Financial Application

Campo	Tipo	Descrição
financial_application_key	string	Chave única de identificação da aplicação financeira
share_capital	float	Valor do aporte
status	string	Enumerador de Financial Application Status
investor	JSON	Objeto de Investor
issuance_serie	JSON	Objeto de Issuance Serie
redemptions	array	Lista de objetos de Redemption (condicional)
amortizations	array	Lista de objetos de Amortization (condicional)
status_events	array	Lista de objetos de Status Event (condicional)
reserved_taxable_yields	array	Lista de objetos de Reserved Taxable Yield (condicional)
financial_application_type	string	Tipo da aplicação financeira (condicional)
original_number_of_quotas	float	Quantidade original de cotas (condicional)
original_number_of_quotas_str	string	Versão string com precisão da quantidade original de cotas (condicional)
current_principal_value	float	Valor atual de principal por cota (condicional)
acquisition_cost	float	Custo de aquisição das cotas da aplicação (condicional)
current_number_of_quotas	float	Quantidade atual de cotas (condicional)
payment_method	string	Método de pagamento (regular, cetip, b3) (condicional)
quotation_date	string	Data de cotização (condicional)
external_id	string	Identificador externo (condicional)

Financial Application Status

Enumerador	Descrição
pending_payment	Pendente pagamento
pending_quote	Pendente cotização
quoted	Cotizado
settled	Totalmente amortizado
redeemed	Totalmente resgatado
canceled	Cancelado

Investor

Campo	Tipo	Descrição
investor_key	string	Chave única de identificação do investidor
name	string	Nome do investidor
person_type	string	natural_person / legal_person / fund_class
distributor	JSON	Objeto de Distributor
document_number	string	CPF/CNPJ do investidor (condicional)
external_id	string	Identificador externo do investidor (condicional)
external_distribution_key	string	Chave externa de distribuição (condicional)

Distributor

Campo	Tipo	Descrição
distributor_key	string	Chave única de identificação do distribuidor
name	string	Nome do distribuidor
document_number	string	CNPJ do distribuidor
account_data	JSON	Objeto com dados bancários do distribuidor

Issuance Serie

Campo	Tipo	Descrição
issuance_serie_key	string	Chave única de identificação da série de emissão
name	string	Nome da série de emissão
serie	string	Identificador da série
internal_code	string	Código interno da série
status	string	Enumerador de status da série de emissão
original_quota_value	float	Valor de cota original
current_quota_value	float	Valor de cota atual (calculado a partir de current_net_worth / current_number_of_quotas)
current_number_of_quotas	float	Quantidade atual de cotas em circulação
current_net_worth	float	Patrimônio líquido atual
current_principal_value	float	Valor de principal atual
performance_fee_current_value	float	Taxa de performance atual
minimum_share_capital	float	Valor mínimo para aplicação
remuneration_type	string	Tipo de remuneração (enumerador)
interest_rate_type	string	Tipo de taxa de juros (enumerador)
processing_method	string	Método de processamento da série (enumerador)
operation_period_configuration	JSON	Configuração do período de operação
sub_class	JSON	Objeto de Sub Class
pre_fixed	JSON	Configuração pré-fixada (condicional)
post_fixed	JSON	Configuração pós-fixada (condicional)
isin_code	string	Código ISIN (condicional)
external_id	string	Identificador externo da série de emissão (condicional)
specific_interest_rate_data	JSON	Dados específicos da taxa de juros (condicional)

Sub Class

Campo	Tipo	Descrição
sub_class_key	string	Chave única de identificação da sub classe
name	string	Nome da sub classe
subordination_level	int	Nível de subordinação da sub classe
fund_class	JSON	Objeto de Fund Class

Fund Class

Campo	Tipo	Descrição
fund_class_key	string	Chave única de identificação da classe de fundo
name	string	Nome da classe de fundo
short_name	string	Nome curto da classe de fundo
document_number	string	CNPJ da classe de fundo
accounting_date	string	Data contábil da classe de fundo
sub_type	string	Subtipo da classe de fundo (enumerador)
tax_classification_id	string	Classificação tributária (enumerador)
condominum_type_id	string	Tipo de condomínio (enumerador)
investment_category_id	string	Categoria de investimento (enumerador)
prevent_payment	boolean	Flag de prevenção de pagamento
integralization_account_key	string	Chave da conta de integralização
manager	JSON	Objeto de Manager

Manager

Campo	Tipo	Descrição
manager_key	string	Chave única de identificação do gestor
manager_name	string	Nome do gestor
document_number	string	CNPJ do gestor