Paginated Query of Financial Application Closing
Requests
Request by fund
ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/financial_application_closingsMETHOD
GETSTATUS
200Query Params
| Parameter | Description |
|---|---|
fund_class_document_number | Fund CNPJ |
issuance_serie_key | Unique identification key of the issuance series |
closing_date | Specific closing date |
from_date | Period start date |
to_date | Period end date |
Warning
There are two ways to consume the resource:
- Consuming a specific date, sending the closing_date field as query param.
- Consuming a period, sending the from_date and to_date fields as query param
If all three parameters are sent, an error will be returned with code [QDI000080]
Responses
Case 01: Successful query
{
"data": [
{
"financial_application": {
"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"
},
"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,
"issuance_serie": {},
"investor_position_key": "UUID"
},
"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"
},
"total_value": 0.00,
"number_of_quotas": 0.00000000,
"principal_value": 0.00,
"ir_value": 0.00,
"iof_value": 0.00,
"yield_value": 0.00,
"taxable_yield_value": 0.00,
"yield_net_value": 0.00,
"accounting_date": "yyyy-mm-dd",
"acquisition_cost": 0.00
}
],
"limit": 50,
"page": 0,
"is_last_page": true
}
Page
| Field | Type | Description |
|---|---|---|
data | array | List of Financial Application objects |
limit | int | Limit of objects retrieved per page |
page | int | Retrieved page number |
is_last_page | boolean | Information indicating whether the retrieved page is the last |
Financial Application Closing
| Field | Type | Description |
|---|---|---|
financial_application | JSON | Financial Application object |
total_value | float | Total closing value of the application |
number_of_quotas | float | Number of quotas |
principal_value | float | Principal value referring to the closing |
ir_value | float | IR value |
iof_value | float | IOF value |
yield_value | float | Gross yield value |
taxable_yield_value | float | Taxable yield value |
yield_net_value | float | Net yield value |
accounting_date | string | Accounting date referring to the application closing |
acquisition_cost | float | Acquisition cost of quotas related to the closing |
Financial Application
| Field | Type | Description | Characters |
|---|---|---|---|
external_id | string | External identifier | up to 100 |
financial_application_key | string | Unique identification key of the financial application | 36 |
share_capital | float | Investment amount | - |
investor_position | JSON | Investor Position object | - |
original_principal_value | float | Original principal value per quota | - |
current_principal_value | float | Current principal value per quota | - |
original_number_of_units | float | Original number of quotas | - |
current_number_of_units | float | Current number of quotas | - |
quotation_date | string | Quotation date | - |
status | string | Financial Application Status enumerator | - |
status_events | array | List of Status Event objects | - |
capital_returns | array | List of Capital Return objects | - |
Financial Application Status
| Enumerator | Description |
|---|---|
pending_payment | Pending payment |
pending_quote | Pending quotation |
quoted | Quoted |
settled | Fully amortized |
redeemed | Fully redeemed |
canceled | Canceled |
Investor Position
| Field | Type | Description |
|---|---|---|
investor | JSON | Investor object |
total_net_worth | float | Net worth of investor position |
total_number_of_quotas | float | Number of quotas in investor position |
issuance_serie | JSON | Issuance Serie object |
investor_position_key | JSON | Unique identification key of investor position |
Investor
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Investor name | up to 255 |
investor_key | string | Unique identification key of investor | 36 |
document_number | string | Investor CPF/CNPJ | 14 or 18 |
person_type | string | Natural Person / Legal Person / Fund Class | up to 50 |
distributor | JSON | Distributor object | - |
account_data | JSON | Account Data object | - |
Distributor
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Distributor name | up to 255 |
distributor_key | string | Unique identification key of distributor | - |
document_number | string | Distributor CPF/CNPJ | 14 or 18 |
account_data | JSON | Account Data object | - |
Account Data
| Field | Type | Description |
|---|---|---|
account_digit | string | Bank account digit |
account_branch | string | Bank account branch number |
account_number | string | Bank account number |
financial_institution_code | string | Financial institution code |
financial_institution_ispb | string | Financial institution identifier in the Brazilian Payment System |
Issuance Serie
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Issuance series name | up to 255 |
issuance_serie_key | string | Unique identification key of issuance series | 36 |
cetip_code | string | Issuance series code as asset in CETIP | 10 |
start_date | string | Issuance series start date | 10 |
maturity_date | string | Issuance series maturity date | 10 |
original_quota_value | float | Original quota value | - |
remuneration_type | string | Yield curve / Residual | up to 50 |
investment_category | string | FIDC / Multimercado | up to 50 |
condominum_type | string | Open / Closed | up to 50 |
tax_classification | string | Short term / Long term | up to 50 |
investment_restriction_type | string | No restriction / Qualified / Professional | up to 50 |
minimum_share_capital | float | Minimum value for investment | - |
accounting_date | string | Accounting date of issuance series | 10 |
sub_class | JSON | Sub Class object | - |
Sub Class
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Sub class name | up to 255 |
sub_class_key | string | Unique identification key of sub class | 36 |
subordination_level | int | Sub class subordination level | - |
fund_class | JSON | Fund Class object | - |
Fund Class
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Fund class name | up to 255 |
fund_class_key | string | Unique identification key of fund class | 36 |
document_number | string | Fund class CNPJ | - |
Capital Return
| Field | Type | Description |
|---|---|---|
capital_return_key | string | Unique identification key of capital return |
origin_key | string | Unique identification key of capital return origin |
net_value | float | Net value of capital return |
iof_value | float | IOF value of capital return |
ir_value | float | IR value of capital return |
payment_date | string | Capital return payment date |
capital_return_date | string | Capital return creation date |
status | string | Sending to Administrator / Pending Payment / Paid |
capital_return_type | string | Amortization / Redemption Request / Come-cotas |
number_of_units | float | Number of quotas of capital return |