跳到主要内容

获取资本回报信息


Request

ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/capital_returns
MÉTODO
GET

Responses

STATUS
200
案例 01:投资者有一笔资本回报
{
"data": [
{
"capital_return_key": "UUID",
"origin_key": "UUID",
"net_value": 0.00,
"iof_value": 0.00,
"ir_value": 0.00,
"capital_return_date": "YYYY-MM-DD",
"payment_date": "YYYY-MM-DD",
"status": "sending_to_administrator / pending_payment / paid",
"capital_return_type": "amortization / redemption_request / tax_anticipation",
"number_of_units": 0.00000000,
"financial_application": {
"financial_application_key": "UUID",
"share_capital": 0.00,
"original_principal_value": 0.00,
"current_principal_value": 0.00,
"original_number_of_units": 0.00000000,
"current_number_of_units": 0.00000000,
"quotation_date": "YYYY-MM-DD",
"status": "pending_payment / pending_quote / quoted / settled / redeemed / canceled",
"investor_position": {
"total_net_worth": 0.00,
"total_number_of_quotas": 0.00000000,
"investor_position_key":"UUID",
"investor": {
"investor_key": "UUID",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
"name": "NAME",
"person_type": "natural_person / legal_person",
"account_data": {
"financial_institution_code": "000",
"account_number": "000000000000",
"account_digit": "0",
"account_branch": "0000",
"financial_institution_ispb": "00000000",
},
"status": "approved / pending_update",
"associations": [
"manager": {
"manager_key": "UUID",
"name": "NAME",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
},
"permissions": [
{"type": "read_data"}
]
],
"distributor": {
"distributor_key": "UUID",
"document_number": "000.000.000-00 / 00.000.000/0001-00",
"name": "NAME",
"account_data": {
"financial_institution_code": "000",
"account_number": "000000000000",
"account_digit": "0",
"account_branch": "0000",
"financial_institution_ispb": "00000000",
},
},
"investor_sub_type": "fund_class / financial_institution"
},
"issuance_serie": {
"issuance_serie_key": "UUID",
"name": "1",
"cetip_code": "0000000SN1",
"start_date": "YYYY-MM-DD",
"maturity_date": "YYYY-MM-DD",
"original_quota_value": 0.00000000000000,
"remuneration_type": "yield_curve / residual",
"interest_rate_type": "post_fixed / post_fixed",
"pre_fixed": {
"calendar_base": "workdays / calendar_360 / calendar_365",
"monthly_rate": 0.00000000000000
},
"post_fixed": {
"calendar_base": "workdays / calendar_360 / calendar_365",
"indexer": "di / ipca",
"rate": 1,
"lag": {"reference": "daily / monthly", "amount": 1},
},
"investment_category": "fidc / multi_market",
"condominum_type": "open_ended / close_ended",
"tax_classification": "short_term / long_term",
"investment_restriction_type": "retail / qualified / professional",
"minimum_share_capital": 0.0,
"accounting_date": "YYYY-MM-DD",
"sub_class": {
"name": "COTA SÊNIOR",
"sub_class_key": "UUID",
"subordination_level": 1,
"fund_class": {
"name": "SAMPLE FUND CLASS NAME",
"fund_class_key": "UUID",
"document_number": "00.000.000/0000-00"
}
}
}
}
},
}
],
"limit": 50,
"page": 0,
"is_last_page": true
}

响应字段

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

Capital Return

字段类型描述
capital_return_keystring资本回报唯一标识键
origin_keystring资本回报来源唯一标识键
net_valuefloat资本回报净值
iof_valuefloat资本回报金融操作税金额
ir_valuefloat资本回报所得税金额
payment_datestring资本回报付款日期
capital_return_datestring资本回报创建日期
statusstring发送至管理人 / 待付款 / 已付款
capital_return_typestring摊销 / 赎回申请 / Come-cotas
number_of_unitsfloat资本回报的份额数量
financial_applicationJSONFinancial Application 对象

Financial Application

| 字段 | 类型 | 描述 | ||-----------------------------|----------|-----------------------------------------------------------------------------------------| | financial_application_key | string | 金融申购唯一标识键 | | share_capital | float | 金融申购的认购金额 | | original_principal_value | float | 金融申购份额价值中的原始本金值 |
| current_principal_value | float | 金融申购份额价值中的当前本金值 | | original_number_of_units | float | 金融申购的原始份额数量 | | current_number_of_units | float | 金融申购的当前份额数量 | | quotation_date | string | 金融申购的报价日期 | | status | string | 待付款 / 待报价 / 已报价 / 已结算 / 已赎回 / 已取消 | | investor_position | JSON | Investor Position 对象 |
| issuance_serie | JSON | Issuance Serie 对象 |

Investor Position

| 字段 | 类型 | 描述 | ||-----------------------------|----------|-----------------------------------------------------------------------------------------| | total_net_worth | float | 投资者持仓总资产净值 | | total_number_of_quotas | float | 投资者持仓份额总数 | | investor | JSON | Investor 对象 |
| issuance_serie | JSON | Issuance Serie 对象 | | investor_position_key | JSON | 投资者持仓唯一标识键 |

Investor

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | investor_key | string | 投资者唯一标识键 | 36 | | document_number | string | 投资者 CPF / CNPJ | 14 至 18 | | name | string | 投资者姓名 / 公司名称 | 最多 255 | | person_type | string | 自然人 / 法人 | 最多 50 | | account_data | JSON | Account Data 对象 | - | | status | string | 已批准 / 待更新 | - | | associations | array | Association 对象列表 | - | | distributor | JSON | Distributor 对象 | - | | investor_sub_type | string | 基金类别 / 金融机构 | 最多 50 |

Account Data

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | financial_institution_code | string | 金融机构编号 | 最多 4 | | account_number | string | 银行账号 | 最多 20 | | account_digit | string | 账号校验位 | 1 | | account_branch | string | 银行支行号 | 最多 4 | | financial_institution_ispb | string | 金融机构 ISPB 代码 | 8 |

Association

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | manager | JSON | Manager 对象 | - | | permissions | array | Permission 对象列表 | - |

Manager

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | manager_key | string | 基金管理人唯一标识键 | 36 | | document_number | string | 管理人 CPF / CNPJ | 14 至 18 | | name | string | 管理人姓名 / 公司名称 | 最多 255 |

Permission

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | type | string | 权限类型名称 | 最多 255 |

Distributor

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | distributor_key | string | 分销商唯一标识键 | 36 | | document_number | string | 分销商 CPF / CNPJ | 14 至 18 | | name | string | 管理人姓名 / 公司名称 | 最多 255 | | account_data | JSON | Account Data 对象 | - |

Issuance Serie

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | issuance_serie_key | string | 发行系列唯一标识键 | 36 | | name | string | 发行系列名称 | 最多 255 | | cetip_code | string | 发行系列在 CETIP 中的资产代码 | 10 |
| start_date | string | 发行系列起始日期 | 10 | | maturity_date | string | 发行系列到期日期 | 10 | | original_quota_value | float | 原始份额价值 | - | | remuneration_type | string | 收益曲线 / 残差 | 最多 50 | | interest_rate_type | string | 浮动利率 / 固定利率 | 最多 50 | | pre_fixed | JSON | Pre fixed 对象 | - | | post_fixed | JSON | Post fixed 对象 | - | | investment_category | string | FIDC / 多市场 | 最多 50 | | condominum_type | string | 开放式 / 封闭式 | 最多 50 | | tax_classification | string | 短期 / 长期 | 最多 50 | | investment_restriction_type | string | 无限制 / 合格投资者 / 专业投资者 | 最多 50 | | minimum_share_capital | float | 最低申购金额 | - | | accounting_date | string | 发行系列会计日期 | 10 | | sub_class | JSON | Sub Class 对象 | - |

Pre fixed

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | calendar_base | string | 工作日 / 360日历 / 365日历 | 最多 255 | | monthly_rate | float | 月利率 | - |

Post fixed

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | calendar_base | string | 工作日 / 360日历 / 365日历 | 最多 255 | | indexer | string | DI / IPCA | 最多 255 | | rate | float | 利率 | - | | lag | JSON | Lag 对象 | - |

Lag

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | reference | string | 每日 / 每月 | 最多 255 | | amount | integer | 滞后数量 | - |

Sub Class

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | sub_class_key | string | 子类唯一标识键 | 36 | | name | string | 子类名称 | 最多 255 | | subordination_level | int | 子类从属层级 | - |
| fund_class | JSON | Fund Class 对象 | - |

Fund Class

| 字段 | 类型 | 描述 | 字符数 | ||-------------------------------|----------|---------------------------------------------------|------------| | fund_class_key | string | 基金类别唯一标识键 | 36 | | name | string | 基金类别名称 | 最多 255 | | document_number | string | 基金类别 CNPJ | - |