Fund Quota Position Query

Returns, for each invested fund, how much your fund has invested: the updated position value in reais, the number of quotas and the date of the latest mark-to-market. Unlike the financial application query, which lists operation by operation, here the response is already consolidated by issuance series of the invested fund.

This is the query to use to find out the balance invested in a cash sweep fund — see Querying the position in a cash sweep fund.

Available on

Profile	Host	Required permission
Manager	manager-api	Read

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/wallet/fund_class/FUND_CLASS_KEY/fund_quota_positions

METHOD

GET

Where FUND_CLASS_KEY is the key of your fund class, the one that holds the quotas.

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 series. 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

Request example

GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=11.222.333/0001-81

Attention

Only positions in active assets are included in the result. Fully redeemed or written-off quotas do not appear.

Response

STATUS

200

Response Body

{
  "data": [
    {
      "quota_fund_class": {
        "name": "Série Única",
        "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 one

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 series' assets
total_current_units	float	Current number of quotas held in the series
last_mtm_date	string	Oldest mark-to-market date among the aggregated positions, in YYYY-MM-DD format
lag	JSON	Pricing lag configuration of the series. Omitted when the series has no lag

Attention

Unlike the Cash Visibility API, where balances come in cents, here total_current_value is a decimal number in reais. E.g.: 1234.56 = R$ 1,234.56.

last_mtm_date is the minimum among the mark-to-market 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 series
quota_fund_class_key	string	Unique key of the invested issuance series
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 series
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 series' operations
isin_code	string	ISIN code of the series. Omitted when the series has no registered 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 application 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 has invested in a specific cash sweep fund, filter by its CNPJ (replace 11.222.333/0001-81 with the cash sweep fund's CNPJ):

Position in a cash sweep fund

GET /wallet/fund_class/{fund_class_key}/fund_quota_positions?document_number=11.222.333/0001-81

The total_current_value in the response is the invested balance, in reais, as of the date indicated by last_mtm_date.

Attention

The same invested fund class may have more than one issuance series. In that case the response returns one row per series, all with the same document_number, and the total balance in the fund is the sum of the returned total_current_value values.

To know the balance in the bank account — the cash not yet invested — use the Cash Visibility endpoints.

Errors

Status	Code	When it happens
403	WLT000098	The fund class does not belong to the integration's manager.
404	WLT000001	Fund class not found.
404	WLT000066	Manager not found.

Authentication, permission and host errors: see API Errors.