跳到主要内容

获取认购公告信息

Request​

ENDPOINT
/quota_offering_control/investor/INVESTOR_KEY/subscription_notes
MÉTODO
GET
注意

以上端点仅适用于担任分销商角色的集成。

ENDPOINT
/quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes
MÉTODO
GET
注意

以上端点仅适用于担任经理角色的集成。

Responses​

STATUS
200
情况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",
            "data":{
               "type":"public / private",
               "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"
               },
               "original_quota_offering_value":0.00
            }
         },
         "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":"send_to_generate_document / pending_document / pending_signature / canceled / active / sold_off",
         "transaction_type":"b3 / ted",
         "original_subscription_note_value":0.00,
         "issued_number_of_quotas":0.00000000,
         "remaining_subscription_note_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"
            }
         ]
      }
   ],
   "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表示已返回页面是否为最后一页

备注​

类型
* 表示该字段可能为空， 如下例所示：
类型
string *

Subscription Note​

字段类型描述
subscription_note_keystring认购公告唯一标识键
quota_offeringJSONQuota Offering 对象
investorJSONInvestor 对象
statusstring发送生成文件 / 待文件 / 待签署 / 已取消 / 活跃 / 已售罄
transaction_typestringB3 / TED
original_subscription_note_valuefloat认购公告原始金额
issued_number_of_quotasfloat已发行份额数量
remaining_subscription_note_valuefloat认购公告剩余金额
start_datestring认购公告起始日期
financial_application_eventsarrayFinancial Application Event 对象列表
maturity_datestring*到期日期
original_number_of_quotasstring*已发行份额数量

Quota Offering​

字段类型描述
quota_offering_keystring发行唯一标识键
statusstring活跃 / 关闭
original_quota_offering_valuefloat发行原始金额
issued_number_of_quotasfloat已认购份额数量
remaining_quota_offering_valuefloat发行剩余金额
start_datestring发行起始日期
issuance_seriestringIssuance Serie 对象
typestring公开/私募发行类型
cvm_registrationJSON *CVM 注册数据
lead_coordinatorJSON *牵头协调人数据
maturity_datestring *到期日期
original_number_of_quotasstring *已发行份额数量
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"
}

Financial Application Event​

字段类型描述
financial_application_keystring财务申请唯一标识键
financial_application_event_keystring财务申请事件唯一标识键
typestring消耗价值 / 更新份额 / 取消
event_datetimestring事件日期和时间
share_capitalfloat *财务申请出资金额 *仅在 'consume_value' 时显示
number_of_quotasfloat *财务申请份额数量 *仅在 'update_quotas' 时显示

Issuance Serie​

字段类型描述
namestring发行系列名称
issuance_serie_keystring发行系列唯一标识键
sub_classJSONSub Class 对象
classificationstring专业 / 合格 / 普通
market_typestring一级 / 二级
serieinteger收益曲线 / 剩余

Sub Class​

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

Fund Class​

字段类型描述
namestring基金类名称
fund_class_keystring基金类唯一标识键
document_numberstring基金类 CNPJ
short_namestring基金类简称

Investor​

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

Distributor​

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