Fund Shares Position Query
This feature is only available for integrations that perform the Manager role.
Returns, for each invested fund, how much your fund class currently holds: the updated position value in reais, the number of shares and the date of the latest pricing. Unlike the financial application query, which lists operation by operation, this response is already consolidated by the invested fund's issuance serie.
This is the query to use when you need the balance invested in a cash sweep fund — see Querying the position in a cash sweep fund.
Request
Where FUND_CLASS_KEY is the key of your fund class, the one holding the shares.
Query Params
| Parameter | Type | Description | Required |
|---|---|---|---|
page | int | Page number. Starts at 0. Default: 0. | No |
limit | int | Number of records per page. Maximum: 50. Default: 10. | No |
document_number | string | CNPJ of the invested fund class, with punctuation. Exact match. | No |
internal_code | string | Internal code of the invested serie. Partial match. | No |
internal_codes | list | List of internal codes. Exact match. | No |
fund_class_name | string | Name of the invested fund class. Partial match. | No |
subclass_name | list | Seniority of the invested subclass: senior, mezzanine, subordinate. | No |
investment_category | list | Category of the invested fund: fidc, fiagro, multi_market, fixed_income, private_equity, equity, real_state. | No |
asset_types | list | Asset type: fidc_fund_quota, fiagro_fund_quota, multi_market_fund_quota, fixed_income_fund_quota, private_equity_fund_quota. | No |
GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=64.289.387/0001-20
Only positions in active assets are included. Fully redeemed or written off shares do not appear.
Response
{
"data": [
{
"quota_fund_class": {
"name": "Single Serie",
"quota_fund_class_key": "UUID",
"document_number": "00.000.000/0000-00",
"fund_class_name": "Invested Fund Class Name",
"fund_class_short_name": "Invested Fund Class Short Name",
"investment_category": "fixed_income",
"tax_classification": "long_term",
"internal_code": "Internal Code",
"subclass_name": "senior",
"entity_category": "fund",
"fund_term_target": "undetermined",
"fund_regime": "open_ended",
"operation_periods": {
"redemption_request": {
"payment": { "days": 0, "type": "fixed", "calendar_base": "workdays" },
"quotation": { "days": 0, "type": "fixed", "calendar_base": "workdays" }
}
},
"isin_code": "BR000000000"
},
"total_current_value": 1234567.89,
"total_current_units": 1180000.0,
"last_mtm_date": "YYYY-MM-DD",
"lag": {
"reference": "daily",
"amount": 1
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
Response Fields
| Field | Type | Description |
|---|---|---|
data | array | List of Position objects |
limit | int | Limit of objects retrieved per page |
page | int | Retrieved page number |
is_last_page | boolean | Indicates whether the retrieved page is the last |
Position
| Field | Type | Description |
|---|---|---|
quota_fund_class | JSON | Invested fund object |
total_current_value | float | Updated position value, in reais. Sum of the current value of the serie's assets |
total_current_units | float | Current number of shares held in the serie |
last_mtm_date | string | Oldest pricing date among the aggregated positions, in YYYY-MM-DD format |
lag | JSON | Pricing lag configuration of the serie. Omitted when the serie has no lag |
Unlike the Cash Visibility API, where balances come in cents, total_current_value here is a decimal number in reais. E.g.: 1234.56 = R$ 1,234.56.
last_mtm_date is the minimum among the pricing dates of the aggregated positions, not the most recent one. Use it to know up to which date the value is guaranteed to be up to date.
Invested fund
| Field | Type | Description |
|---|---|---|
name | string | Name of the invested issuance serie |
quota_fund_class_key | string | Unique key of the invested issuance serie |
document_number | string | CNPJ of the invested fund class |
fund_class_name | string | Name of the invested fund class |
fund_class_short_name | string | Short name of the invested fund class |
investment_category | string | Investment category of the invested fund |
tax_classification | string | Tax classification of the invested fund |
internal_code | string | Internal code of the invested serie |
subclass_name | string | Seniority of the invested subclass |
entity_category | string | Category of the invested entity |
fund_term_target | string | Target term of the invested fund |
fund_regime | string | Regime of the invested fund |
operation_periods | JSON | Quotation and settlement periods for the serie's operations |
isin_code | string | ISIN code of the serie. Omitted when the serie has no ISIN |
Querying the position in a cash sweep fund
Cash sweep funds are liquidity funds used to invest your fund class's idle cash, with subscription and redemption by automatic debit. The operation is performed through the Create Financial Application and Create Redemption Request endpoints, sending the source_account_key.
To query how much your fund class holds in a specific cash sweep fund, filter by its CNPJ:
GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=64.289.387/0001-20
The total_current_value in the response is the invested balance, in reais, as of the date indicated by last_mtm_date.
The same invested fund class may have more than one issuance serie. In that case the response returns one row per serie, all with the same document_number, and the total balance in the fund is the sum of the returned total_current_value.
To know the bank account balance — the cash not yet invested — use the Cash Visibility endpoints.
Possible errors
Fund class not found
{
"title": " Fund Class not Found",
"description": "Fund Class with key {fund_class_key} was not found.",
"translation": "A Fund Class com chave {fund_class_key} não foi encontrado.",
"code": "WLT000001"
}
Manager not found
{
"title": "Not Found Manager",
"description": "Manager with the key {manager_key} was not found.",
"translation": "O gestor com a chave {manager_key} não foi encontrado.",
"code": "WLT000066"
}
Fund class does not belong to the integration's manager
{
"title": "Forbidden Agent",
"description": "The agent with agent key ({agent_key}) can't access this resource.",
"translation": "O agente com chave ({agent_key}) não pode acessar esse recurso.",
"code": "WLT000098"
}