Pular para o conteúdo principal

Carteira - Recuperação da Carteira

Lista de Carteiras​

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/compositions
MÉTODO
GET
Request Body
{
    "data": [
        {
            "composition_key": "f2208257-1489-4937-8862-031bca34016f",
            "status": "confirmed",
            "type": "pre_quota",
            "composition_date": "2024-11-13",
            "fund_class": {
                "name": "A SAMPLE CLASS",
                "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
                "document_number": "18.687.469/0001-06"
            }
        },
        {
            "composition_key": "f2208257-1489-4937-8862-031bca34016f",
            "status": "confirmed",
            "type": "final_quota",
            "composition_date": "2024-11-13",
            "fund_class": {
                "name": "A SAMPLE CLASS",
                "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
                "document_number": "18.687.469/0001-06"
            }
        }
    ],
    "limit": 50,
    "page": 0,
    "is_last_page": true
}

Objeto Paginado​

CampoTipoDescrição
dataarrayLista de objetos de Composition
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

Composition​

CampoTipoDescrição
composition_keystringChave única de identificação da carteira
statusstringO status daquela carteira
typestringO tipo daquela carteira, pre_quota/final_quota
composition_datestringData de referência da carteira
fund_classobjectObjeto de Fund Class

Fund Class​

CampoTipoDescriçãoCaracteres
namestringNome da classe de fundoaté 255
fund_class_keystringChave única de identificação da classe de fundo36
document_numberstringCNPJ da classe de fundo-

Informações da Carteira​

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/composition/COMPOSITION_KEY
MÉTODO
GET
Request Body
{
    "composition_key": "f2208257-1489-4937-8862-031bca34016f",
    "status": "confirmed",
    "type": "pre_quota",
    "composition_date": "2024-12-02",
    "fund_class": {
        "name": "A SAMPLE CLASS",
        "fund_class_key": "5dac941c-c779-4049-a4ee-7cee583b6860",
        "document_number": "18.687.469/0001-06"
    },
    "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,
        "profitabilities": [
            {
                "reference_date": "2024-11-29", 
                "quota_value": 1.76065188,
                "di_benchmark_quota_value": 1.7613906
            },
            {
                "reference_date": "2024-11-25", 
                "quota_value": 1.7568068,
                "di_benchmark_quota_value": 1.76049545
            },
            {
                "reference_date": "2024-11-01", 
                "quota_value": 1.74121452,
                "di_benchmark_quota_value": 1.75502225
            },
            {
                "reference_date": "2024-10-03", 
                "quota_value": 1.72167143,
                "di_benchmark_quota_value": 1.75002091
            },
            {
                "reference_date": "2024-09-03", 
                "quota_value": 1.70128747,
                "di_benchmark_quota_value": 1.74445962
            },
            {
                "reference_date": "2024-06-05", 
                "quota_value": 1.63380383,
                "di_benchmark_quota_value": 1.7178922
            },
            {
                "reference_date": "2023-12-08", 
                "quota_value": 1.52421994,
                "di_benchmark_quota_value": 1.68553599
            }
        ]
      }
    ],
    "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",
            "total_units": 175623,
            "bad_debt_value": 0,
            "overdue_accounting_value": 75642,
            "current_accounting_value": 187762590,
            "current_fair_accounting_value": 187762590
        }
    ],
    "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"
        }
      }
    ]
}

Composition Completo​

CampoTipoDescrição
composition_keystringChave única de identificação da carteira
statusstringO status daquela carteira
typestringO tipo daquela carteira, pre_quota/final_quota
composition_datestringData de referência da carteira
fund_classobjectObjeto de Fund Class
issuance_seriesarrayLista de objetos de Issuance Series
assetsarrayLista de objetos de Assets
consolidated_assetsarrayLista de objetos de Consolidated Assets
receivablesarrayLista de objetos de Receivables
payablesarrayLista de objetos de Paybles
cash_accountsarrayLista de objetos de Cash Accounts

Issuance Serie​

CampoTipoDescrição
issuance_serie_keystringChave única de identificação da série de emissão
namestringO nome daquela série
gross_net_worthfloatO PL Bruto daquela série
net_net_worthfloatO PL Líquido daquela série
gross_quota_valuefloatValor da Cota Bruta
net_quota_valuefloatValor da Cota Líquida
number_of_quotasfloatNúmero Total de Cotas
profitabilitiesarrayLista de objetos de Profitability

Profitability​

CampoTipoDescrição
reference_datestringData de Referência no qual a performance é analisada
quota_valuefloatO valor da Cota da Série na Data de Referência
di_benchmark_quota_valuefloatO valor da Cota hoje caso a Cota de referência rodasse a 100% do DI

Assets​

CampoTipoDescrição
asset_keystringChave única de identificação do ativo
asset_typestringO Tipo do ativo
purchase_datestringData de Aquisição do ativo
total_purchase_valuestringValor Total de Aquisição do Ativo
bad_debt_percentagestring% de PDD aplicado
bad_debt_valueintegerValor total de PDD considerado - Inteiro em centavos
overdue_accounting_valueintegerValor vencido do Ativo - Inteiro em centavos
current_accounting_valueintegerValor total do Ativo - Inteiro em centavos
current_fair_accounting_valueintegerValor total do Ativo - Inteiro em centavos

Consolidated Assets​

CampoTipoDescrição
asset_typestringO Tipo do ativo
total_unitsstringO número total de Ativos consolidados desse tipo
bad_debt_valueintegerValor total de PDD considerado - Inteiro em centavos
overdue_accounting_valueintegerValor vencido do Ativo - Inteiro em centavos
current_accounting_valueintegerValor total do Ativo - Inteiro em centavos
current_fair_accounting_valueintegerData de Referência no qual a performance é analisada

Receivables​

CampoTipoDescrição
origin_keystringChave única de identificação do recurso que origina esse A Receber
origin_typestringO Tipo do recurso que origina esse A Receber
descriptionstringDescrição do item
total_valuefloatO valor Total A Receber
recognized_valuefloatO valor que já foi apropriado
start_datestringA data de início de apropriação
end_datestringO data de fim da apropriação
payment_datestringA data de Liquidação

Payables​

CampoTipoDescrição
origin_keystringChave única de identificação do recurso que origina esse A Pagar
origin_typestringO Tipo do recurso que origina esse A Pagar
descriptionstringDescrição do item
total_valuefloatO valor Total A Pagar
recognized_valuefloatO valor que já foi apropriado
start_datestringA data de início de apropriação
end_datestringO data de fim da apropriação
payment_datestringA data de Liquidação

Cash Accounts​

CampoTipoDescrição
account_keystringChave única de identificação da conta
balanceintegerO saldo da conta - Inteiro em centavos
unconcilied_cash_inintegerO valor de Entradas A Conciliar nessa conta - Inteiro em centavos
unconcilied_cash_outintegerO valor de Saídas A Conciliar nessa conta - Inteiro em centavos
account_branchstringA Agência da conta
account_digitstringO Dígito da conta
account_numberstringO número da conta
accounting_identificationintegerO identificador contábil daquela conta
financial_institutionobjectObjetos de Financial Institution

Financial Institution​

CampoTipoDescrição
codestringCódigo COMPE da IF
ispbstringO ISPB da IF
namestringO nome da IF