Skip to main content

Query Financial Application by Key

Request​

ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY
METHOD
GET
STATUS
200

Responses​

Case 01: Successful query
{
    "external_id": "",
    "financial_application_key": "UUID",
    "share_capital": 0.00,
    "investor_position": {
        "investor": {
            "investor_key": "UUID",
            "document_number": "999.999.999-99" | "99.999.999/9999-99",
            "name": "",
            "person_type": "natural_person" | "legal_person",
            "account_data": {
                "owner": {
                    "name": "",
                    "document_number": "99.999.999/9999-99"
                },"issuance_serie": {},
                "account_digit": "0",
                "account_branch": "0000",
                "account_number": "00000",
                "financial_institution_code": "000",
                "financial_institution_ispb": "00000000"
            },
            "distributor": {
                "distributor_key": "UUID",
                "document_number": "99.999.999/9999-99",
                "name": "",
                "account_data": {
                    "owner": {
                        "name": "",
                        "document_number": "99.999.999/9999-99"
                    },
                    "account_digit": "0",
                    "account_branch": "0000",
                    "account_number": "00000",
                    "financial_institution_code": "000",
                    "financial_institution_ispb": "00000000"
                },
            }
        },
        "total_net_worth": 0.00,
        "total_number_of_quotas": 0.00000000,
        "investor_position_key": "UUID",
        "issuance_serie":{
            "name":"1",
            "cetip_code":"0000000SN1",
            "start_date":"YYYY-MM-DD",
            "maturity_date":"YYYY-MM-DD",
            "original_quota_value":0.00000000000000,
            "remuneration_type":"yield_curve",
            "interest_rate_type":"post_fixed",
            "pre_fixed":{
               "calendar_base":"workdays / calendar_360 / calendar_365",
               "monthly_rate":0.00000000000000
            },
            "post_fixed":{
               "calendar_base":"workdays / calendar_360 / calendar_365",
               "indexer":"di / ipca",
               "rate":1,
               "lag":{
                  "reference":"daily / monthly",
                  "amount":1
               }
            },
            "investment_category":"fidc / multi_market",
            "condominum_type":"open_ended / close_ended",
            "tax_classification":"short_term / long_term",
            "investment_restriction_type":"just_professional",
            "issuance_serie_key":"UUID",
            "minimum_share_capital":0.0,
            "accounting_date":"YYYY-MM-DD",
            "sub_class":{
               "name":"COTA SÊNIOR",
               "sub_class_key":"UUID",
               "subordination_level":1,
               "fund_class":{
                  "name":"SAMPLE FUND CLASS NAME",
                  "fund_class_key":"UUID",
                  "document_number":"00.000.000/0000-00"
               }
            }
        }
    },
    "original_principal_value": 0.00000000,
    "current_principal_value": 0.00000000,
    "original_number_of_units": 0.00000000,
    "current_number_of_units": 0.00000000,
    "quotation_date": "yyyy-mm-dd",
    "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled",
    "status_events": [
        {
            "event_datetime": "yyyy-mm-dd HH:MM:SS:ms",
            "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled",
        }
    ],
    "capital_returns": [
        {
            "capital_return_key": "UUID",
            "origin_key": "UUID",
            "net_value": 0.00,
            "iof_value": 0.00,
            "ir_value": 0.00,
            "payment_date": "yyyy-mm-dd",
            "capital_return_date": "yyyy-mm-dd",
            "status": "",
            "capital_return_type": "",
            "number_of_units": "",
        }
    ],
}

Financial Application​

FieldTypeDescriptionCharacters
external_idstringExternal identifierup to 100
financial_application_keystringUnique identification key for the financial application36
share_capitalfloatInvestment amount-
investor_positionJSONInvestor Position object-
original_principal_valuefloatOriginal principal value per share-
current_principal_valuefloatCurrent principal value per share-
original_number_of_unitsfloatOriginal quantity of shares-
current_number_of_unitsfloatCurrent quantity of shares-
quotation_datestringQuotation date-
statusstringFinancial Application Status enumerator-
status_eventsarrayList of Status Event objects-
capital_returnsarrayList of Capital Return objects-

Financial Application Status​

EnumeratorDescription
pending_paymentPending payment
pending_quotePending quotation
quotedQuoted
settledFully amortized
redeemedFully redeemed
canceledCanceled

Investor Position​

FieldTypeDescription
investorJSONInvestor object
total_net_worthfloatNet worth of the investor's position
total_number_of_quotasfloatNumber of shares in the investor's position
issuance_serieJSONIssuance Serie object
investor_position_keyJSONUnique identification key for the investor's position

Investor​

FieldTypeDescriptionCharacters
namestringInvestor's nameup to 255
investor_keystringUnique identification key for the investor36
document_numberstringCPF/CNPJ of the investor14 or 18
person_typestringNatural Person / Legal Person / Fund Classup to 50
distributorJSONDistributor object-
account_dataJSONAccount Data object-

Distributor​

FieldTypeDescriptionCharacters
namestringDistributor's nameup to 255
distributor_keystringUnique identification key for the distributor-
document_numberstringCPF/CNPJ of the distributor14 or 18
account_dataJSONAccount Data object-

Account Data​

FieldTypeDescription
account_digitstringBank account digit
account_branchstringBank account branch number
account_numberstringBank account number
financial_institution_codestringFinancial institution code
financial_institution_ispbstringBrazilian Payment System identifier for the financial institution

Issuance Serie​

FieldTypeDescriptionCharacters
namestringIssuance series nameup to 255
issuance_serie_keystringUnique identification key for the issuance series36
cetip_codestringIssuance series code as asset in CETIP10
start_datestringIssuance series start date10
maturity_datestringIssuance series maturity date10
original_quota_valuefloatOriginal share value-
remuneration_typestringYield curve / Residualup to 50
investment_categorystringFIDC / Multi-marketup to 50
condominum_typestringOpen-ended / Close-endedup to 50
tax_classificationstringShort-term / Long-termup to 50
investment_restriction_typestringNo restriction / Qualified / Professionalup to 50
minimum_share_capitalfloatMinimum value for investment-
accounting_datestringAccounting date of the issuance series10
sub_classJSONSub Class object-

Sub Class​

FieldTypeDescriptionCharacters
namestringSub class nameup to 255
sub_class_keystringUnique identification key for the sub class36
subordination_levelintSubordination level of the sub class-
fund_classJSONFund Class object-

Fund Class​

FieldTypeDescriptionCharacters
namestringFund class nameup to 255
fund_class_keystringUnique identification key for the fund class36
document_numberstringCNPJ of the fund class-

Capital Return​

FieldTypeDescription
capital_return_keystringUnique identification key for the capital return
origin_keystringUnique identification key for the capital return origin
net_valuefloatNet value of the capital return
iof_valuefloatIOF value of the capital return
ir_valuefloatIR value of the capital return
payment_datestringPayment date of the capital return
capital_return_datestringCreation date of the capital return
statusstringSending to Administrator / Pending Payment / Paid
capital_return_typestringAmortization / Redemption Request / Come-cotas
number_of_unitsfloatNumber of shares of the capital return