Skip to main content

Portfolio - Portfolio Retrieval

Portfolio List​

Lists the portfolios of a fund class, paginated, from the most recent date to the oldest.

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiView Compositions

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/compositions
METHOD
GET

Query Params​

ParameterDescription
not_statusFilters the results, excluding compositions in the given status.
statusFilters the results, returning only compositions in the given status.
reference_dateReference date for querying the compositions. Must be in the YYYY-MM-DD format.
typePortfolio type: pre_quota, final_quota or opening_quota.
start_dateStart date of the search range. Required if end_date is given. Format: YYYY-MM-DD.
end_dateEnd date of the search range. Required if start_date is given. Format: YYYY-MM-DD.
pagePage to retrieve, starting at 0. Default: 0.
limitItems per page. Default: 20; maximum: 100.

status and not_status accept more than one value (?status=pending_confirmation&status=confirmed). The possible statuses of a portfolio are created, pending_processing, pending_validation, pending_variation_reason, pending_quota_performance, pending_confirmation, confirmed, reproved, reproved_by_agent and reprocessed. The portfolio awaiting your approval is in pending_confirmation.

Attention

There are two ways to filter by date:

  • A specific date, sending the reference_date query param.
  • A period, sending the start_date and end_date query params (both together).
Response Body
{
    "data": [
        {
            "composition_key": "f2208257-1489-4937-8862-031bca34016f",
            "status": "confirmed",
            "composition_type": "pre_quota",
            "composition_date": "2024-11-13",
            "fund_class": {
                "name": "A SAMPLE CLASS",
                "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
                "document_number": "11.222.333/0001-81"
            }
        },
        {
            "composition_key": "f2208257-1489-4937-8862-031bca34016f",
            "status": "confirmed",
            "composition_type": "final_quota",
            "composition_date": "2024-11-13",
            "fund_class": {
                "name": "A SAMPLE CLASS",
                "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
                "document_number": "11.222.333/0001-81"
            }
        }
    ],
    "limit": 20,
    "page": 0,
    "is_last_page": true
}

Paginated Object​

FieldTypeDescription
dataarrayList of Composition objects
limitintLimit of objects retrieved per page
pageintNumber of the retrieved page
is_last_pagebooleanIndicates whether the retrieved page is the last one

Composition​

FieldTypeDescription
composition_keystringUnique portfolio identification key
statusstringThe status of that portfolio
composition_typestringThe type of that portfolio, pre_quota/final_quota
composition_datestringReference date of the portfolio
fund_classobjectFund Class object

Fund Class​

FieldTypeDescriptionCharacters
namestringFund class nameup to 255
fund_class_keystringUnique fund class identification key36
document_numberstringFund class CNPJ-

Portfolio Information​

Returns the complete portfolio: issuance series, assets, receivables, payables, accounts and the status history.

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiView Compositions

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/composition/COMPOSITION_KEY
METHOD
GET
Response Body
{
    "composition_key": "f2208257-1489-4937-8862-031bca34016f",
    "status": "confirmed",
    "composition_type": "pre_quota",
    "composition_date": "2024-12-02",
    "fund_class": {
        "name": "A SAMPLE CLASS",
        "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
        "document_number": "11.222.333/0001-81"
    },
    "issuance_series": [
      {
        "issuance_serie_key": "840e01e9-0df8-4719-83c4-f10b839d8384",
        "name": "SUBORDINADA - 1",
        "gross_net_worth": 1891397.29,
        "net_net_worth": 1891397.29,
        "gross_quota_value": 1.76821576,
        "net_quota_value": 1.76821576,
        "number_of_quotas": 1069664.309518427,
        "applied_value": 0.0,
        "applied_quotas": 0.0,
        "redeemed_value": 0.0,
        "redeemed_quotas": 0.0,
        "amortized_value": 0.0,
        "tax_anticipated_value": 0.0,
        "tax_anticipated_quotas": 0.0,
        "profitabilities": [
            {
                "reference_date": "2024-11-29",
                "quota_value": 1.76065188,
                "di_benchmark_quota_value": 1.7613906,
                "quota_percentage": 100.43,
                "di_benchmark_percentage": 100.43,
                "type": "monthly"
            },
            {
                "reference_date": "2024-11-25",
                "quota_value": 1.7568068,
                "di_benchmark_quota_value": 1.76049545,
                "quota_percentage": 99.79,
                "di_benchmark_percentage": 100.0,
                "type": "monthly"
            },
            {
                "reference_date": "2024-11-01",
                "quota_value": 1.74121452,
                "di_benchmark_quota_value": 1.75502225,
                "quota_percentage": 99.21,
                "di_benchmark_percentage": 100.0,
                "type": "monthly"
            },
            {
                "reference_date": "2024-10-03",
                "quota_value": 1.72167143,
                "di_benchmark_quota_value": 1.75002091,
                "quota_percentage": 98.38,
                "di_benchmark_percentage": 100.0,
                "type": "monthly"
            },
            {
                "reference_date": "2024-09-03",
                "quota_value": 1.70128747,
                "di_benchmark_quota_value": 1.74445962,
                "quota_percentage": 97.52,
                "di_benchmark_percentage": 100.0,
                "type": "monthly"
            },
            {
                "reference_date": "2024-06-05",
                "quota_value": 1.63380383,
                "di_benchmark_quota_value": 1.7178922,
                "quota_percentage": 95.1,
                "di_benchmark_percentage": 100.0,
                "type": "monthly"
            },
            {
                "reference_date": "2023-12-08",
                "quota_value": 1.52421994,
                "di_benchmark_quota_value": 1.68553599,
                "quota_percentage": 90.43,
                "di_benchmark_percentage": 100.0,
                "type": "daily"
            }
        ]
      }
    ],
    "assets": [
        {
            "asset_key": "34f42521-f27f-424a-958f-8b53f15cc80d",
            "asset_type": "fixed_income_fund_quota",
            "purchase_date": "2024-11-27",
            "total_purchase_value": 1009320,
            "bad_debt_percentage": 0,
            "bad_debt_value": 0,
            "overdue_accounting_value": 0,
            "current_accounting_value": 1234335,
            "current_fair_accounting_value": 1234335
        }
    ],
    "consolidated_assets": [
        {
            "asset_type": "ccb",
            "asset_category": "credit",
            "total_units": 175623,
            "bad_debt_value": 0,
            "overdue_accounting_value": 75642,
            "current_accounting_value": 187762590,
            "current_fair_accounting_value": 187762590,
            "post_maturity_interest_value": 0,
            "delay_interest_value": 0,
            "delay_fine_value": 0
        }
    ],
    "receivables": [
        {
          "origin_key": "a60f9226-edac-488e-9a58-6205a334e6ba",
          "origin_type": "expense",
          "description": "Taxa CVM - 2024",
          "total_value": 711515,
          "recognized_value": 654125,
          "start_date": "2024-01-09",
          "end_date": "2024-12-31",
          "payment_date": "2024-05-10"
        }
    ],
    "payables": [
      {
        "origin_key": "19b83b17-d36c-4edd-97fe-99af6a0a4a63",
        "origin_type": "expense",
        "description": "Taxa de Gestão - 2024/12",
        "total_value": 14586,
        "recognized_value": 14586,
        "start_date": "2024-12-02",
        "end_date": "2024-12-31",
        "payment_date": "2025-01-08"
      }
    ],
    "cash_accounts": [
      {
        "account_key": "a41e4fa8-6950-485e-9a5b-70f21cc6774a",
        "balance": 100000,
        "unconcilied_cash_in": 0,
        "unconcilied_cash_out": 0,
        "account_branch": "0001",
        "account_digit": "1",
        "account_number": "372832",
        "accounting_identification": 1,
        "financial_institution": {
            "code": "329",
            "ispb": "32402502",
            "name": "QI Sociedade de Crédito Direto"
        }
      }
    ]
}

Complete Composition​

FieldTypeDescription
composition_keystringUnique portfolio identification key
statusstringThe status of that portfolio
composition_typestringThe type of that portfolio, pre_quota/final_quota
composition_datestringReference date of the portfolio
fund_classobjectFund Class object
issuance_seriesarrayList of Issuance Series objects
assetsarrayList of Assets objects
consolidated_assetsarrayList of Consolidated Assets objects
receivablesarrayList of Receivables objects
payablesarrayList of Payables objects
cash_accountsarrayList of Cash Accounts objects
status_eventsarrayStatus history of the portfolio. See Status Events

Issuance Serie​

FieldTypeDescription
issuance_serie_keystringUnique issuance series identification key
namestringThe name of that series
gross_net_worthfloatGross net worth of that series
net_net_worthfloatNet worth of that series
gross_quota_valuefloatGross quota value
net_quota_valuefloatNet quota value
number_of_quotasfloatTotal number of quotas
applied_valuefloatTotal value applied in the period (optional)
applied_quotasfloatNumber of quotas applied in the period (optional)
redeemed_valuefloatTotal value redeemed in the period (optional)
redeemed_quotasfloatNumber of quotas redeemed in the period (optional)
amortized_valuefloatTotal value amortized in the period (optional)
tax_anticipated_valuefloatAnticipated tax value (optional)
tax_anticipated_quotasfloatNumber of quotas of the anticipated tax (optional)
isin_codestringISIN code of the series (optional)
profitabilitiesarrayList of Profitability objects

Profitability​

FieldTypeDescription
reference_datestringReference date on which performance is analyzed
quota_valuefloatSeries quota value on the reference date
di_benchmark_quota_valuefloatQuota value today if the reference quota ran at 100% of DI
quota_percentagefloatAccumulated profitability of the quota in the period (%)
di_benchmark_percentagefloatAccumulated profitability of the DI benchmark in the period (%)
typestringType of the profitability period

Assets​

FieldTypeDescription
asset_keystringUnique asset identification key
asset_typestringAsset type
purchase_datestringAsset acquisition date
total_purchase_valuestringTotal asset acquisition value
bad_debt_percentagestringApplied PDD percentage
bad_debt_valueintegerTotal PDD value considered - Integer in cents
overdue_accounting_valueintegerAsset overdue value - Integer in cents
current_accounting_valueintegerAsset total value - Integer in cents
current_fair_accounting_valueintegerAsset total value - Integer in cents

Consolidated Assets​

FieldTypeDescription
asset_typestringAsset type
asset_categorystringAsset category
total_unitsintegerTotal number of consolidated assets of this type
bad_debt_valueintegerTotal PDD value considered - Integer in cents
overdue_accounting_valueintegerAsset overdue value - Integer in cents
current_accounting_valueintegerAsset total value - Integer in cents
current_fair_accounting_valueintegerAsset total fair value - Integer in cents
post_maturity_interest_valueintegerPost-maturity interest - Integer in cents
delay_interest_valueintegerLate-payment interest - Integer in cents
delay_fine_valueintegerLate-payment fine - Integer in cents

Receivables​

FieldTypeDescription
origin_keystringUnique identification key of the resource that originates this receivable
origin_typestringType of the resource that originates this receivable
descriptionstringItem description
total_valuefloatTotal receivable value
recognized_valuefloatValue already accrued
start_datestringAccrual start date
end_datestringAccrual end date
payment_datestringSettlement date

Payables​

FieldTypeDescription
origin_keystringUnique identification key of the resource that originates this payable
origin_typestringType of the resource that originates this payable
descriptionstringItem description
total_valuefloatTotal payable value
recognized_valuefloatValue already accrued
start_datestringAccrual start date
end_datestringAccrual end date
payment_datestringSettlement date

Cash Accounts​

FieldTypeDescription
account_keystringUnique account identification key
balanceintegerAccount balance - Integer in cents
unconcilied_cash_inintegerValue of inflows to reconcile in this account - Integer in cents
unconcilied_cash_outintegerValue of outflows to reconcile in this account - Integer in cents
account_branchstringAccount branch
account_digitstringAccount digit
account_numberstringAccount number
accounting_identificationintegerAccounting identifier of that account
financial_institutionobjectFinancial Institution object
account_dataobjectObject with the account data (contains the same fields above)

Financial Institution​

FieldTypeDescription
codestringFinancial institution COMPE code
ispbstringFinancial institution ISPB
namestringFinancial institution name

Status Events​

FieldTypeDescription
statusstringStatus assumed by the portfolio
event_datetimestringDate and time of the status change
metadataobjectData about the change, when available. On a rejection by the manager, contains the reproved_reason sent

Errors​

StatusCodeWhen it happens
400CMP000016Listing with only one of start_date and end_date.
400CMP000017Listing with end_date earlier than start_date.
400QIT000004The fund_class_key belongs to a class of another manager.
400QIT000010Invalid query parameter: limit above 100, negative page or reference_date not in YYYY-MM-DD.
404CMP000001There is no class with this fund_class_key.
404CMP000012Query of a composition_key that does not exist in the given class.

Authentication, permission and host errors: see API Errors.