Retrieving Investor Closed Position Information
Request
ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/investor_position_closingsMÉTODO
GETQuery Params
| Parameter | Description |
|---|---|
closing_date | Specific closing date |
from_date | Period start date |
to_date | Period end date |
Attention
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
STATUS
200Response example
{
"data": [
{
"accounting_date":"2024-03-06",
"total_value":1100.0,
"number_of_quotas":11.0,
"ir_value":0.0,
"iof_value":0.0,
"yield_value":0.0,
"yield_net_value":0.0,
"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"
}
}
}
}
],
"limit": 50,
"page": 0,
"is_last_page": true
}
Response Fields
| Field | Type | Description |
|---|---|---|
data | array | List of Investor Position Closing objects |
limit | int | Limit of objects retrieved per page |
page | int | Retrieved page number |
is_last_page | boolean | Information indicating if the retrieved page is the last one |
Investor Position Closing
| Field | Type | Description |
|---|---|---|
accounting_date | string | Closing reference date |
total_value | float | Total equity of the investor's closed position |
number_of_quotas | float | Number of shares in the investor's closed position |
ir_value | float | Income tax of the investor's closed position |
iof_value | float | IOF of the investor's closed position |
yield_value | float | Yield of the investor's closed position |
yield_net_value | float | Net yield of the investor's closed position |
issuance_serie | JSON | Issuance Serie object |
Issuance Serie
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Issuance series name | up to 255 |
issuance_serie_key | string | Unique identification key of the issuance series | 36 |
cetip_code | string | Issuance series code as CETIP asset | 10 |
start_date | string | Issuance series start date | 10 |
maturity_date | string | Issuance series maturity date | 10 |
original_quota_value | float | Original share value | - |
remuneration_type | string | Yield curve / Residual | up to 50 |
investment_category | string | FIDC / Multi-market | 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 | Issuance series accounting date | 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 the 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 the fund class | 36 |
document_number | string | Fund class CNPJ | - |