Issuance Series Query
Returns, paginated, the fund issuance series registered for quota investment. Use the returned issuance_serie_key to create an application or a redemption request.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | View Applications, Redemptions and Series |
For a consultant, the list only includes the series of fund classes linked to the consultant; with no link, data is empty.
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/trade_fund_quota/issuance_seriesMETHOD
GETQuery Params
| Parameter | Type | Description |
|---|---|---|
page | int | Page number, starting at 0. Default: 0. |
limit | int | Records per page. Default: 10. Maximum: 100. |
fund_class_document_number | string | CNPJ of the series' fund, with punctuation (e.g. 11.222.333/0001-81). Partial match. |
fund_class_name | string | Name of the series' fund. Partial match. |
internal_code | string | Internal code of the series. Partial match. |
internal_codes | list | Internal codes, comma-separated. Exact match. |
status | list | Statuses to include: created, active, inactive, pre_operational. Without this filter, inactive series are not returned. |
not_status | list | Statuses to exclude, comma-separated. |
sub_class_name | list | Subclass names, comma-separated (accent- and case-insensitive). |
search | string | Partial search on the fund's short name, the series name, the internal code or the CNPJ. |
Response
STATUS
200Case 01: Return with one series
{
"data": [
{
"issuance_serie_key": "UUID",
"name": "Invested Issuance Serie Name",
"subclass_name": "Invested Sub Class Name",
"serie": 1,
"quota_calculation_method": "quota_value",
"condominium_type": "open_ended",
"internal_code": "Internal Code",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class short name",
"fund_class_document_number": "00.000.000/0000-00",
"minimum_share_capital": 0.0,
"investment_category": "multi_market",
"asset_type": "multi_market_fund_quota",
"payment_type": "transfer",
"status": "active",
"financial_institution_code": "329",
"account_data": {
"account_digit": "0",
"account_branch": "0001",
"account_number": "12345",
"financial_institution_code": "329",
"financial_institution_ispb": "00000000"
},
"last_updated_date": "YYYY-MM-DD",
"administrator": {
"administrator_key": "UUID",
"name": "Administrator Name",
"document_number": "00.000.000/0000-00",
"status": "active"
},
"operation_periods": {
"redemption_request": {
"payment": {
"days": 1,
"type": "until",
"calendar_base": "calendar_365"
},
"quotation": {
"days": 1,
"type": "fixed",
"calendar_base": "calendar_365"
}
},
"amortization_request": {
"payment": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
},
"quotation": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
}
},
"financial_application": {
"payment": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
},
"quotation": {
"days": 0,
"type": "fixed",
"calendar_base": "workdays"
}
}
},
"isin_code": "BR000000000"
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
Page
| Field | Type | Description |
|---|---|---|
data | array | List of Issuance Serie objects |
limit | int | Limit of objects retrieved per page |
page | int | Number of the retrieved page |
is_last_page | boolean | Information indicating whether the retrieved page is the last |
Issuance Serie
| Field | Type | Description |
|---|---|---|
| issuance_serie_key | string | Unique key of the issuance series |
| name | string | Name of the issuance series |
| subclass_name | string | Subclass name (e.g., SUBORDINADA) |
| serie | int | Series number |
| quota_calculation_method | string | Quota calculation method (e.g., quota_value) |
| internal_code | string | Internal code of the series |
| fund_class_name | string | Name of the fund class associated with the series |
| fund_class_short_name | string | Short name of the fund class |
| fund_class_document_number | string | CNPJ of the fund class |
| minimum_share_capital | float | Minimum value for investment |
| investment_category | string | Investment category (e.g., multi_market) |
| payment_type | string | Payment type (e.g., transfer) |
| account_data | JSON | Account Data object |
| last_updated_date | string | Last update date (YYYY-MM-DD) |
| administrator | JSON | Administrator object |
| operation_periods | JSON | Operation Periods object |
| isin_code | string | ISIN code of the series |
| condominium_type | string | open_ended (open) or close_ended (closed). Only open_ended series accept redemptions. |
| asset_type | string | Asset type (e.g. multi_market_fund_quota) |
| status | string | created, active, inactive or pre_operational |
| financial_institution_code | string | Code of the financial institution used for automatic debit |
Administrator
| Field | Type | Description |
|---|---|---|
| administrator_key | string | Unique key of the administrator |
| name | string | Administrator name |
| document_number | string | Administrator CNPJ |
| status | string | active or blocked |
Operation Periods
| Field | Type | Description |
|---|---|---|
| redemption_request | JSON | Quotation and Payment periods object for redemptions |
| amortization_request | JSON | Quotation and Payment periods object for amortizations |
| financial_application | JSON | Quotation and Payment periods object for applications |
Quotation and Payment
| Field | Type | Description |
|---|---|---|
| days | int | Number of days |
| type | string | Counting type (e.g., fixed, until) |
| calendar_base | string | Calendar base (e.g., workdays, calendar_365) |
Account Data
| Field | Type | Description |
|---|---|---|
| account_digit | string | Bank account digit |
| account_branch | string | Bank branch number |
| account_number | string | Bank account number |
| financial_institution_code | string | Financial institution code |
| financial_institution_ispb | string | Financial institution ISPB (Brazilian Payment System) |
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | TFQ000002 | The integration's manager is not registered on the platform. |
Authentication, permission and host errors: see API Errors.