跳到主要内容

获取认购公告信息


以分页方式列出某投资者或某基金类别的认购公告。

Request​

投资者的认购公告​

适用范围
角色主机所需权限
管理人manager-api读取

各主机的 Base URL:环境(主机)。

ENDPOINT
/quota_offering_control/investor/INVESTOR_KEY/subscription_notes
MÉTODO
GET
STATUS
200

管理人只能获取其所管理基金的发行下的认购公告。

Query param描述
limit每页条目数。默认 50,最大 500
page页码,从 0 开始。默认 0
status按状态过滤。可传入多个值,以逗号分隔
issuance_serie_key按发行系列过滤
fund_class_document_number按基金类别 CNPJ 过滤
financial_application_key按金融申请过滤
quotation_date与 status=sold_off 一起使用时,返回在该日期(YYYY-MM-DD)售罄的认购公告

基金类别的认购公告​

适用范围
角色主机所需权限
管理人manager-api读取

各主机的 Base URL:环境(主机)。

ENDPOINT
/quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes
MÉTODO
GET
STATUS
200
Query param描述
limit每页条目数。默认 50,最大 500
page页码,从 0 开始。默认 0
status按状态过滤。可传入多个值,以逗号分隔
investor_key按投资者过滤
investor_document_number按投资者 CPF/CNPJ 过滤

Responses​

案例 01:有认购公告的投资者
{
"data":[
{
"subscription_note_key":"UUID",
"quota_offering":{
"quota_offering_key":"UUID",
"status":"active / closed",
"original_quota_offering_value":0.00,
"issued_number_of_quotas":0.00000000,
"remaining_quota_offering_value":0.00,
"start_date":"YYYY-MM-DD",
"issuance_serie":{
"name":"1",
"issuance_serie_key":"UUID",
"sub_class":{
"name":"SÊNIOR",
"sub_class_key":"UUID",
"subordination_level":1,
"fund_class":{
"fund_class_key":"UUID",
"name":"SAMPLE FUND CLASS NAME",
"document_number":"00.000.000/0000-00",
"short_name":"SAMPLE FUND CLASS SHORT NAME"
}
},
"classification":"general / qualified / professional",
"market_type":"primary / secondary"
},
"type":"public / private",
"subscription_note_template_key":"UUID",
"subscription_note_generation_type":"internal / external",
"regulatory_type":"exclusive_fund",
"cvm_registration":{
"date":"YYYY-MM-DD",
"number":"AAA/BBB/CCC/DDD/EEE/YYYY/000"
},
"lead_coordinator":{
"name":"SAMPLE LEAD COORDINATOR NAME",
"address":{
"uf":"SP",
"city":"São Paulo",
"number":"0000",
"street":"Sample street name",
"complement":"Sample complement"
},
"document_number":"00.000.000/0000-00"
},
"status_events":[
{
"status":"active",
"event_datetime":"YYYY-MM-DD HH:MM:SS"
}
]
},
"investor":{
"distributor":{
"distributor_key":"UUID",
"document_number":"00.000.000/0000-00",
"name":"Sample Distributor Name"
},
"investor_key":"UUID",
"document_number":"00.000.000/0000-00",
"name":"SAMPLE INVESTOR NAME",
"person_type":"natural_person / legal_person"
},
"status":"active",
"transaction_type":"b3 / ted",
"signature_method":"certifiqi / qi_sign / opt_in / external",
"original_subscription_note_value":0.00,
"issued_number_of_quotas":0.00000000,
"remaining_subscription_note_value":0.00,
"total_assignment_value":0.00,
"start_date":"YYYY-MM-DD",
"financial_application_events":[
{
"financial_application_event_key":"UUID",
"financial_application_key":"UUID",
"type":"consume_value",
"share_capital":0.00,
"event_datetime":"YYYY-MM-DD HH:MM:SS"
},
{
"financial_application_event_key":"UUID",
"financial_application_key":"UUID",
"type":"update_quotas",
"number_of_quotas":0.00,
"event_datetime":"YYYY-MM-DD HH:MM:SS"
},
{
"financial_application_event_key":"UUID",
"financial_application_key":"UUID",
"type":"cancel",
"event_datetime":"YYYY-MM-DD HH:MM:SS"
}
],
"status_events":[
{
"status":"created",
"event_datetime":"YYYY-MM-DD HH:MM:SS"
},
{
"status":"active",
"event_datetime":"YYYY-MM-DD HH:MM:SS"
}
]
}
],
"limit":50,
"page":0,
"is_last_page":true
}
案例 02:没有认购公告的投资者
{
"data":[],
"limit":50,
"page":0,
"is_last_page":true
}

Response Fields​

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

Subscription Note​

字段类型描述
subscription_note_keystring认购公告唯一标识键
quota_offeringJSONQuota Offering 对象
investorJSONInvestor 对象
statusstring认购公告状态。参见 Subscription Note Status
signature_methodstringcertifiqi / qi_sign / opt_in / external
total_assignment_valuefloat认购公告的转让总额
status_eventsarray状态历史(status、event_datetime)
transaction_typestringted / b3
original_subscription_note_valuefloat认购公告原始金额
issued_number_of_quotasfloat已发行份额数量
remaining_subscription_note_valuefloat认购公告剩余金额
start_datestring认购公告开始日期
financial_application_eventsarrayFinancial Application Event 对象列表
maturity_datestring到期日期。未填写时不返回
original_number_of_quotasfloat原始份额数量。未填写时不返回

Subscription Note Status​

枚举值描述
created已创建
pending_batch_close等待批次关闭
send_to_generate_document已发送生成文件
pending_document等待文件
pending_manual_inputs等待手动录入数据(外部生成)
pending_signature等待签署
active_without_signature有效(未签署)
active有效
sold_off已售罄
processing_cancellation取消中
canceled已取消
processing_expired过期处理中
expired已过期

Quota Offering​

quota_offering 对象的字段与 发行信息 响应中的字段相同,包括嵌套的 issuance_serie、sub_class 和 fund_class 对象。

Financial Application Event​

字段类型描述
financial_application_keystring金融申请唯一标识键
financial_application_event_keystring金融申请事件唯一标识键
typestring消耗金额 / 更新份额 / 取消
event_datetimestring事件日期和时间
share_capitalfloat金融申请的出资金额。仅当 type 为 consume_value 时返回
number_of_quotasfloat金融申请的份额数量。仅当 type 为 update_quotas 时返回

Investor​

字段类型描述
namestring投资者名称
investor_keystring投资者唯一标识键
document_numberstring投资者 CPF/CNPJ
person_typestring自然人 / 法人 / 基金类别
distributorJSONDistributor 对象

Distributor​

字段类型描述
namestring分销商名称
distributor_keystring分销商唯一标识键
document_numberstring分销商 CPF/CNPJ

错误​

状态代码发生情形
400QIT000004该基金类别不由该管理人管理
404QOF000007未找到基金类别
404QOF000017未找到投资者

认证、权限和主机相关错误:参见 API 错误。