Skip to main content

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
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiView 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_series
METHOD
GET

Query Params​

ParameterTypeDescription
pageintPage number, starting at 0. Default: 0.
limitintRecords per page. Default: 10. Maximum: 100.
fund_class_document_numberstringCNPJ of the series' fund, with punctuation (e.g. 11.222.333/0001-81). Partial match.
fund_class_namestringName of the series' fund. Partial match.
internal_codestringInternal code of the series. Partial match.
internal_codeslistInternal codes, comma-separated. Exact match.
statuslistStatuses to include: created, active, inactive, pre_operational. Without this filter, inactive series are not returned.
not_statuslistStatuses to exclude, comma-separated.
sub_class_namelistSubclass names, comma-separated (accent- and case-insensitive).
searchstringPartial search on the fund's short name, the series name, the internal code or the CNPJ.

Response​

STATUS
200
Case 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​

FieldTypeDescription
dataarrayList of Issuance Serie objects
limitintLimit of objects retrieved per page
pageintNumber of the retrieved page
is_last_pagebooleanInformation indicating whether the retrieved page is the last

Issuance Serie​

FieldTypeDescription
issuance_serie_keystringUnique key of the issuance series
namestringName of the issuance series
subclass_namestringSubclass name (e.g., SUBORDINADA)
serieintSeries number
quota_calculation_methodstringQuota calculation method (e.g., quota_value)
internal_codestringInternal code of the series
fund_class_namestringName of the fund class associated with the series
fund_class_short_namestringShort name of the fund class
fund_class_document_numberstringCNPJ of the fund class
minimum_share_capitalfloatMinimum value for investment
investment_categorystringInvestment category (e.g., multi_market)
payment_typestringPayment type (e.g., transfer)
account_dataJSONAccount Data object
last_updated_datestringLast update date (YYYY-MM-DD)
administratorJSONAdministrator object
operation_periodsJSONOperation Periods object
isin_codestringISIN code of the series
condominium_typestringopen_ended (open) or close_ended (closed). Only open_ended series accept redemptions.
asset_typestringAsset type (e.g. multi_market_fund_quota)
statusstringcreated, active, inactive or pre_operational
financial_institution_codestringCode of the financial institution used for automatic debit

Administrator​

FieldTypeDescription
administrator_keystringUnique key of the administrator
namestringAdministrator name
document_numberstringAdministrator CNPJ
statusstringactive or blocked

Operation Periods​

FieldTypeDescription
redemption_requestJSONQuotation and Payment periods object for redemptions
amortization_requestJSONQuotation and Payment periods object for amortizations
financial_applicationJSONQuotation and Payment periods object for applications

Quotation and Payment​

FieldTypeDescription
daysintNumber of days
typestringCounting type (e.g., fixed, until)
calendar_basestringCalendar base (e.g., workdays, calendar_365)

Account Data​

FieldTypeDescription
account_digitstringBank account digit
account_branchstringBank branch number
account_numberstringBank account number
financial_institution_codestringFinancial institution code
financial_institution_ispbstringFinancial institution ISPB (Brazilian Payment System)

Errors​

StatusCodeWhen it happens
404TFQ000002The integration's manager is not registered on the platform.

Authentication, permission and host errors: see API Errors.