跳到主要内容

投资组合 - 获取

投资组合列表​

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/compositions
MÉTODO
GET

Query Params​

参数描述
not_status过滤结果，排除指定状态的组合。
status过滤结果，仅返回指定状态的组合。
reference_date查询组合的参考日期，格式为 YYYY-MM-DD。
type要过滤的组合类型 pre_quota/final_quota。
start_date查询范围的开始日期，若提供 end_date 则必填。格式：YYYY-MM-DD。
end_date查询范围的结束日期，若提供 start_date 则必填。格式：YYYY-MM-DD。
注意

按日期过滤有两种方式：

  • 通过 query param 字段 reference_date 查询特定日期。
  • 通过 query param 字段 start_date 和 end_date 查询时间段。
Response 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
}

分页对象​

字段类型描述
dataarrayComposition 对象列表
limitint每页返回的对象数量上限
pageint当前返回的页码
is_last_pageboolean表示当前页是否为最后一页

Composition​

字段类型描述
composition_keystring投资组合的唯一标识键
statusstring该投资组合的状态
typestring该投资组合的类型，pre_quota/final_quota
composition_datestring投资组合的参考日期
fund_classobjectFund Class 对象

Fund Class​

字段类型描述字符数
namestring基金类别名称最多 255
fund_class_keystring基金类别的唯一标识键36
document_numberstring基金类别的 CNPJ-

投资组合详情​

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/composition/COMPOSITION_KEY
MÉTODO
GET
Response 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,
        "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
            },
            {
                "reference_date": "2024-11-25", 
                "quota_value": 1.7568068,
                "di_benchmark_quota_value": 1.76049545
            }
        ]
      }
    ]
}

完整 Composition 字段​

字段类型描述
composition_keystring投资组合的唯一标识键
statusstring该投资组合的状态
typestring该投资组合的类型，pre_quota/final_quota
composition_datestring投资组合的参考日期
fund_classobjectFund Class 对象
issuance_seriesarrayIssuance Series 对象列表
assetsarrayAssets 对象列表
consolidated_assetsarrayConsolidated Assets 对象列表
receivablesarrayReceivables 对象列表
payablesarrayPayables 对象列表
cash_accountsarrayCash Accounts 对象列表

Issuance Serie​

字段类型描述
issuance_serie_keystring发行系列的唯一标识键
namestring该系列名称
gross_net_worthfloat该系列的总净资产
net_net_worthfloat该系列的净净资产
gross_quota_valuefloat总配额价值
net_quota_valuefloat净配额价值
number_of_quotasfloat总配额数量
profitabilitiesarrayProfitability 对象列表

Profitability​

字段类型描述
reference_datestring分析绩效的参考日期
quota_valuefloat该参考日期时的系列配额价值
di_benchmark_quota_valuefloat若参考配额以 100% DI 运行至今的模拟配额价值

Assets​

字段类型描述
asset_keystring资产的唯一标识键
asset_typestring资产类型
purchase_datestring资产购入日期
total_purchase_valuestring资产的总购入价值
bad_debt_percentagestring已应用的坏账准备比例
bad_debt_valueinteger考虑的坏账准备总值 - 以分为单位的整数
overdue_accounting_valueinteger资产逾期金额 - 以分为单位的整数
current_accounting_valueinteger资产总金额 - 以分为单位的整数
current_fair_accounting_valueinteger资产总公允价值 - 以分为单位的整数

Consolidated Assets​

字段类型描述
asset_typestring资产类型
total_unitsstring该类型合并资产的总数量
bad_debt_valueinteger考虑的坏账准备总值 - 以分为单位的整数
overdue_accounting_valueinteger资产逾期金额 - 以分为单位的整数
current_accounting_valueinteger资产总金额 - 以分为单位的整数
current_fair_accounting_valueinteger分析绩效的参考日期

Receivables​

字段类型描述
origin_keystring产生此应收款项的资源的唯一标识键
origin_typestring产生此应收款项的资源类型
descriptionstring项目描述
total_valuefloat应收总金额
recognized_valuefloat已计提的金额
start_datestring计提开始日期
end_datestring计提结束日期
payment_datestring清算日期

Payables​

字段类型描述
origin_keystring产生此应付款项的资源的唯一标识键
origin_typestring产生此应付款项的资源类型
descriptionstring项目描述
total_valuefloat应付总金额
recognized_valuefloat已计提的金额
start_datestring计提开始日期
end_datestring计提结束日期
payment_datestring清算日期

Cash Accounts​

字段类型描述
account_keystring账户的唯一标识键
balanceinteger账户余额 - 以分为单位的整数
unconcilied_cash_ininteger该账户待对账的收入金额 - 以分为单位的整数
unconcilied_cash_outinteger该账户待对账的支出金额 - 以分为单位的整数
account_branchstring账户支行
account_digitstring账户校验位
account_numberstring账户号码
accounting_identificationinteger该账户的会计标识
financial_institutionobjectFinancial Institution 对象

Financial Institution​

字段类型描述
codestring金融机构 COMPE 代码
ispbstring金融机构 ISPB
namestring金融机构名称