Query Financial Application by Key

Returns a financial application of an investor by key.

Available on

Profile	Host	Required permission
Manager	manager-api	Read
Consultant	consultant-api	Granted by the integration team

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY

METHOD

GET

STATUS

200

The manager only queries investors it is linked to; the consultant, applications in funds where it has permission.

Responses

Case 01: Successful query

{
    "financial_application_key": "UUID",
    "external_id": "SEU_ID_EXTERNO",
    "share_capital": 1000.0,
    "status": "quoted",
    "financial_application_type": "primary_market",
    "payment_method": "regular",
    "central_depositary": "unregistered",
    "quotation_date": "2025-01-10",
    "original_number_of_quotas": 998.12345678,
    "original_number_of_quotas_str": "998.12345678",
    "current_number_of_quotas": 998.12345678,
    "current_principal_value": 1000.0,
    "acquisition_cost": 1000.0,
    "status_events": [
        {
            "event_datetime": "2025-01-09T14:30:00Z",
            "status": "pending_payment"
        },
        {
            "event_datetime": "2025-01-10T21:00:00Z",
            "status": "quoted"
        }
    ],
    "redemptions": [],
    "amortizations": [],
    "investor": {
        "investor_key": "UUID",
        "name": "INVESTIDOR EXEMPLO",
        "person_type": "natural_person",
        "document_number": "969.698.790-03",
        "distributor": {
            "distributor_key": "UUID",
            "document_number": "11.222.333/0001-81",
            "name": "DISTRIBUIDORA EXEMPLO",
            "account_data": {}
        }
    },
    "issuance_serie": {
        "issuance_serie_key": "UUID",
        "name": "SERIE 1",
        "serie": 1,
        "status": "active",
        "remuneration_type": "yield_curve",
        "original_quota_value": 1.0,
        "current_quota_value": 1.0018,
        "minimum_share_capital": 0.0,
        "sub_class": {
            "name": "COTA SÊNIOR",
            "sub_class_key": "UUID",
            "subordination_level": 1,
            "fund_class": {
                "name": "FUNDO EXEMPLO",
                "fund_class_key": "UUID",
                "document_number": "11.222.333/0001-81"
            }
        }
    },
    "water_mark_events": []
}

Optional fields (external_id, original_number_of_quotas, current_number_of_quotas, current_principal_value, acquisition_cost, quotation_date) only appear when filled in. The status_events, redemptions, amortizations and reserved_taxable_yields lists are omitted when empty.

Financial Application

Field	Type	Description
financial_application_key	string	Unique key of the financial application
external_id	string	External identifier
share_capital	float	Invested amount
status	string	Financial Application Status enumerator
financial_application_type	string	primary_market (application) or secondary_market (secondary market)
payment_method	string	regular (Pix or TED) or b3
central_depositary	string	unregistered or cetip
quotation_date	string	Quotation date (yyyy-mm-dd)
original_number_of_quotas	float	Number of quotas at quotation (_str: the same value as a string, without rounding)
current_number_of_quotas	float	Current number of quotas
current_principal_value	float	Current principal
acquisition_cost	float	Acquisition cost
status_events	array	Status history: status and event_datetime (UTC)
redemptions	array	Redemptions that consumed the application: redemption_key, redemption_type, number_of_quotas, total_value, ir_value, iof_value, yield_value, taxable_yield_value, redemption_date
amortizations	array	Paid amortizations: amortization_key, payment_date, total_value, principal_reduction, acquisition_cost_reduction and, when present, yield_value, taxable_yield_value, ir_value, iof_value
reserved_taxable_yields	array	Reserved taxable yields (come-cotas)
investor	object	Investor: investor_key, name, person_type, document_number and distributor
issuance_serie	object	Issuance series, with sub_class and sub_class.fund_class
water_mark_quota_value	float	High-water mark reference quota value (performance fee), when present
water_mark_reference_date	string	High-water mark reference date, when present
water_mark_events	array	High-water mark events

Financial Application Status

Enumerator	Description
created	Created
pending_formalization	Pending formalization (subscription note)
pending_payment	Pending payment
processing_quotation	Quotation in progress
pending_quote	Pending quotation
processing_issuance_serie_impacts	Processing impacts on the series
quoted	Quoted
settled	Fully amortized
redeemed	Fully redeemed
canceled	Canceled
reprocessed	Reprocessed

Errors

Status	Code	When it happens
400	QIT000004	The manager is not linked to the investor
403	QTA000315	The consultant has no permission on the application's fund
404	QTA000021	Investor not found
404	QTA000260	Financial application not found for the investor

Authentication, permission and host errors: see API Errors.