跳到主要内容

金融申请结算分页查询

Requests​

按基金类别查询
ENDPOINT
/quota/fund_class/FUND_CLASS_KEY/financial_application_closings
MÉTODO
GET
STATUS
200

Query Params​

参数描述
accounting_date特定记账结算日期（格式 yyyy-mm-dd）
from_date期间开始日期（格式 yyyy-mm-dd）
to_date期间结束日期（格式 yyyy-mm-dd）
limit每页返回的对象数量限制（最小 0，最大 75，默认 75）
page返回的页码（最小 0，默认 0）
注意

必须发送 accounting_date 或 from_date 与 to_date 的组合。如果未发送其中任何一个参数，资源将返回必填参数缺失的错误。

按投资者和金融申请查询
ENDPOINT
/quota/investor/INVESTOR_KEY/financial_application/FINANCIAL_APPLICATION_KEY/financial_application_closings
MÉTODO
GET
STATUS
200

Query Params​

参数描述
last_financial_application_closing布尔值。当为 true 时，仅返回该申请的最新结算。默认：false。
limit每页返回的对象数量限制（最小 0，最大 500，默认 50）
page返回的页码（最小 0，默认 0）

Responses​

情况01：查询成功
{
    "data": [
        {
            "financial_application": {
                "financial_application_key": "UUID",
                "share_capital": 0.00,
                "status": "pending_payment" | "pending_quote" | "quoted" | "settled" | "redeemed" | "canceled",
                "investor": {
                    "investor_key": "UUID",
                    "name": "",
                    "person_type": "natural_person" | "legal_person",
                    "document_number": "999.999.999-99" | "99.999.999/9999-99",
                    "distributor": {
                        "distributor_key": "UUID",
                        "name": "",
                        "document_number": "99.999.999/9999-99",
                        "account_data": {}
                    }
                },
                "issuance_serie": {},
                "financial_application_type": "regular",
                "payment_method": "regular" | "cetip" | "b3",
                "quotation_date": "yyyy-mm-dd",
                "current_principal_value": 0.00000000,
                "current_number_of_quotas": 0.00000000,
                "original_number_of_quotas": 0.00000000,
                "original_number_of_quotas_str": "0.00000000",
                "acquisition_cost": 0.00,
                "external_id": "",
                "redemptions": [],
                "amortizations": [],
                "status_events": [],
                "reserved_taxable_yields": []
            },
            "total_value": 0.00,
            "number_of_quotas": 0.00000000,
            "principal_value": 0.00,
            "acquisition_cost": 0.00,
            "yield_value": 0.00,
            "ir_value": 0.00,
            "iof_value": 0.00,
            "taxable_yield_value": 0.00,
            "accounting_date": "yyyy-mm-dd"
        }
    ],
    "limit": 75,
    "page": 0,
    "is_last_page": true
}
注意

financial_application 对象中以下字段为条件性字段——仅在底层数据存在时才会返回：

  • redemptions[]、amortizations[]、status_events[]、reserved_taxable_yields[]：列表为空时省略。
  • original_number_of_quotas（及其同级 original_number_of_quotas_str）、current_principal_value、acquisition_cost、current_number_of_quotas、quotation_date：在申请的报价处理后填充。
  • payment_method、financial_application_type、external_id：每个申请可选——在创建或后续更新时提供时返回。

外层（data、limit、page、is_last_page）以及 Financial Application Closing 对象的字段在响应中始终存在。

Page​

字段类型描述
dataarrayFinancial Application Closing 对象列表
limitint每页返回的对象数量限制
pageint返回的页码
is_last_pageboolean指示返回的页面是否为最后一页的信息

Financial Application Closing​

字段类型描述
financial_applicationJSONFinancial Application 对象
total_valuefloat申请结算总价值
number_of_quotasfloat结算相关份额数量
principal_valuefloat结算相关本金价值
acquisition_costfloat结算相关份额的购置成本
yield_valuefloat毛收益价值
ir_valuefloatIR 金额
iof_valuefloatIOF 金额
taxable_yield_valuefloat应税收益价值
accounting_datestring申请结算相关记账日期

Financial Application​

字段类型描述
financial_application_keystring金融申请唯一标识键
share_capitalfloat投资金额
statusstringFinancial Application Status 枚举值
investorJSONInvestor 对象
issuance_serieJSONIssuance Serie 对象
redemptionsarrayRedemption 对象列表 （条件性）
amortizationsarrayAmortization 对象列表 （条件性）
status_eventsarrayStatus Event 对象列表 （条件性）
reserved_taxable_yieldsarrayReserved Taxable Yield 对象列表 （条件性）
financial_application_typestring金融申请类型 （条件性）
original_number_of_quotasfloat原始份额数量 （条件性）
original_number_of_quotas_strstring原始份额数量的高精度字符串版本 （条件性）
current_principal_valuefloat每单位当前本金价值 （条件性）
acquisition_costfloat申请份额的购置成本 （条件性）
current_number_of_quotasfloat当前份额数量 （条件性）
payment_methodstring支付方式（regular、cetip、b3） （条件性）
quotation_datestring报价日期 （条件性）
external_idstring外部标识符 （条件性）

Financial Application Status​

枚举值描述
pending_payment待支付
pending_quote待报价
quoted已报价
settled已完全摊销
redeemed已完全赎回
canceled已取消

Investor​

字段类型描述
investor_keystring投资者唯一标识键
namestring投资者姓名
person_typestringnatural_person / legal_person / fund_class
distributorJSONDistributor 对象
document_numberstring投资者 CPF/CNPJ （条件性）
external_idstring投资者外部标识符 （条件性）
external_distribution_keystring外部分销键 （条件性）

Distributor​

字段类型描述
distributor_keystring分销商唯一标识键
namestring分销商名称
document_numberstring分销商 CNPJ
account_dataJSON分销商银行账户数据对象

Issuance Serie​

字段类型描述
issuance_serie_keystring发行系列唯一标识键
namestring发行系列名称
seriestring系列标识符
internal_codestring系列内部代码
statusstring发行系列状态枚举值
original_quota_valuefloat原始份额价值
current_quota_valuefloat当前份额价值（由 current_net_worth / current_number_of_quotas 计算）
current_number_of_quotasfloat当前流通份额数量
current_net_worthfloat当前净资产
current_principal_valuefloat当前本金价值
performance_fee_current_valuefloat当前业绩费
minimum_share_capitalfloat最低投资金额
remuneration_typestring收益类型（枚举值）
interest_rate_typestring利率类型（枚举值）
processing_methodstring系列处理方法（枚举值）
operation_period_configurationJSON运营期配置
sub_classJSONSub Class 对象
pre_fixedJSON预固定配置 （条件性）
post_fixedJSON后固定配置 （条件性）
isin_codestringISIN 代码 （条件性）
external_idstring发行系列外部标识符 （条件性）
specific_interest_rate_dataJSON特定利率数据 （条件性）

Sub Class​

字段类型描述
sub_class_keystring子类别唯一标识键
namestring子类别名称
subordination_levelint子类别从属级别
fund_classJSONFund Class 对象

Fund Class​

字段类型描述
fund_class_keystring基金类别唯一标识键
namestring基金类别名称
short_namestring基金类别简称
document_numberstring基金类别 CNPJ
accounting_datestring基金类别记账日期
sub_typestring基金类别子类型（枚举值）
tax_classification_idstring税务分类（枚举值）
condominum_type_idstring集合形式（枚举值）
investment_category_idstring投资类别（枚举值）
prevent_paymentboolean阻止支付标志
integralization_account_keystring缴款账户键
managerJSONManager 对象

Manager​

字段类型描述
manager_keystring管理人唯一标识键
manager_namestring管理人姓名
document_numberstring管理人 CNPJ