Skip to main content

Paginated Query of Financial Application Closing

Requests​

Request by fund class
ENDPOINT
/quota/fund_class/FUND_CLASS_KEY/financial_application_closings
METHOD
GET
STATUS
200

Query Params​

ParameterDescription
accounting_dateSpecific accounting closing date (format yyyy-mm-dd)
from_datePeriod start date (format yyyy-mm-dd)
to_datePeriod end date (format yyyy-mm-dd)
limitLimit of objects retrieved per page (minimum 0, maximum 75, default 75)
pageRetrieved page number (minimum 0, default 0)
Warning

You must send accounting_date or the combination of from_date and to_date. If none of these parameters is sent, the resource will return a missing required parameters error.

Request by investor and financial application
ENDPOINT
/quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY/financial_application_closings
METHOD
GET
STATUS
200

Query Params​

ParameterDescription
last_financial_application_closingBoolean. When true, returns only the latest closing of the application. Default: false.
limitLimit of objects retrieved per page (minimum 0, maximum 500, default 50)
pageRetrieved page number (minimum 0, default 0)

Responses​

Case 01: Successful query
{
    "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
}
Warning

The fields below in the financial_application object are conditional — only returned when the underlying data exists:

  • redemptions[], amortizations[], status_events[], reserved_taxable_yields[]: lists are omitted when empty.
  • original_number_of_quotas (and its sibling original_number_of_quotas_str), current_principal_value, acquisition_cost, current_number_of_quotas, quotation_date: populated after the application's quotation processing.
  • payment_method, financial_application_type, external_id: optional per application — returned when provided at creation or in a later update.

The envelope (data, limit, page, is_last_page) and the fields of the Financial Application Closing object are always present in the response.

Page​

FieldTypeDescription
dataarrayList of Financial Application Closing objects
limitintLimit of objects retrieved per page
pageintRetrieved page number
is_last_pagebooleanInformation indicating whether the retrieved page is the last

Financial Application Closing​

FieldTypeDescription
financial_applicationJSONFinancial Application object
total_valuefloatTotal closing value of the application
number_of_quotasfloatNumber of quotas referring to the closing
principal_valuefloatPrincipal value referring to the closing
acquisition_costfloatAcquisition cost of the quotas related to the closing
yield_valuefloatGross yield value
ir_valuefloatIR value
iof_valuefloatIOF value
taxable_yield_valuefloatTaxable yield value
accounting_datestringAccounting date referring to the application closing

Financial Application​

FieldTypeDescription
financial_application_keystringUnique identification key of the financial application
share_capitalfloatInvestment amount
statusstringFinancial Application Status enumerator
investorJSONInvestor object
issuance_serieJSONIssuance Serie object
redemptionsarrayList of Redemption objects (conditional)
amortizationsarrayList of Amortization objects (conditional)
status_eventsarrayList of Status Event objects (conditional)
reserved_taxable_yieldsarrayList of Reserved Taxable Yield objects (conditional)
financial_application_typestringFinancial application type (conditional)
original_number_of_quotasfloatOriginal number of quotas (conditional)
original_number_of_quotas_strstringPrecision-preserving string version of the original number of quotas (conditional)
current_principal_valuefloatCurrent principal value per quota (conditional)
acquisition_costfloatAcquisition cost of the application's quotas (conditional)
current_number_of_quotasfloatCurrent number of quotas (conditional)
payment_methodstringPayment method (regular, cetip, b3) (conditional)
quotation_datestringQuotation date (conditional)
external_idstringExternal identifier (conditional)

Financial Application Status​

EnumeratorDescription
pending_paymentPending payment
pending_quotePending quotation
quotedQuoted
settledFully amortized
redeemedFully redeemed
canceledCanceled

Investor​

FieldTypeDescription
investor_keystringUnique identification key of the investor
namestringInvestor name
person_typestringnatural_person / legal_person / fund_class
distributorJSONDistributor object
document_numberstringInvestor CPF/CNPJ (conditional)
external_idstringExternal identifier of the investor (conditional)
external_distribution_keystringExternal distribution key (conditional)

Distributor​

FieldTypeDescription
distributor_keystringUnique identification key of the distributor
namestringDistributor name
document_numberstringDistributor CNPJ
account_dataJSONDistributor bank account data object

Issuance Serie​

FieldTypeDescription
issuance_serie_keystringUnique identification key of the issuance series
namestringIssuance series name
seriestringSeries identifier
internal_codestringSeries internal code
statusstringIssuance series status enumerator
original_quota_valuefloatOriginal quota value
current_quota_valuefloatCurrent quota value (calculated from current_net_worth / current_number_of_quotas)
current_number_of_quotasfloatCurrent number of quotas in circulation
current_net_worthfloatCurrent net worth
current_principal_valuefloatCurrent principal value
performance_fee_current_valuefloatCurrent performance fee
minimum_share_capitalfloatMinimum value for investment
remuneration_typestringRemuneration type (enumerator)
interest_rate_typestringInterest rate type (enumerator)
processing_methodstringSeries processing method (enumerator)
operation_period_configurationJSONOperation period configuration
sub_classJSONSub Class object
pre_fixedJSONPre-fixed configuration (conditional)
post_fixedJSONPost-fixed configuration (conditional)
isin_codestringISIN code (conditional)
external_idstringExternal identifier of the issuance series (conditional)
specific_interest_rate_dataJSONSpecific interest rate data (conditional)

Sub Class​

FieldTypeDescription
sub_class_keystringUnique identification key of the sub class
namestringSub class name
subordination_levelintSub class subordination level
fund_classJSONFund Class object

Fund Class​

FieldTypeDescription
fund_class_keystringUnique identification key of the fund class
namestringFund class name
short_namestringFund class short name
document_numberstringFund class CNPJ
accounting_datestringFund class accounting date
sub_typestringFund class sub-type (enumerator)
tax_classification_idstringTax classification (enumerator)
condominum_type_idstringCondominium type (enumerator)
investment_category_idstringInvestment category (enumerator)
prevent_paymentbooleanPrevent payment flag
integralization_account_keystringIntegralization account key
managerJSONManager object

Manager​

FieldTypeDescription
manager_keystringUnique identification key of the manager
manager_namestringManager name
document_numberstringManager CNPJ