Skip to main content

Retrieving Information about Subscription Note

Request​

ENDPOINT
/quota_offering_control/investor/INVESTOR_KEY/subscription_notes
MÉTODO
GET
Attention

The endpoint above is only available for integrations that play the Distributor role.

ENDPOINT
/quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes
MÉTODO
GET
Attention

The endpoint above is only available for integrations that play the Manager role.

Responses​

STATUS
200
Case 01: Investor with a Subscription Note
{
   "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
}
Case 02: Investor without Subscription Note
{
   "data":[],
   "limit":50,
   "page":0,
   "is_last_page":true
}

Response Fields​

FieldTypeDescription
dataarrayList of Subscription Note objects
limitintLimit of objects retrieved per page
pageintNumber of the retrieved page
is_last_pagebooleanInformation indicating if the retrieved page is the last one

Note​

TYPE
* means that the field can be null, as in the example below:
Type
string *

Subscription Note​

FieldTypeDescription
subscription_note_keystringUnique subscription note identification key
quota_offeringJSONQuota Offering object
investorJSONInvestor object
statusstringSend to generate document / Pending document / Pending signature / Canceled / Active / Sold out
transaction_typestringB3 / TED
original_subscription_note_valuefloatOriginal subscription note value
issued_number_of_quotasfloatNumber of issued quotas
remaining_subscription_note_valuefloatRemaining subscription note value
start_datestringSubscription note start date
financial_application_eventsarrayList of Financial Application Event objects
maturity_datestring*Maturity date
original_number_of_quotasstring*Number of issued quotas

Quota Offering​

FieldTypeDescription
quota_offering_keystringUnique offering identification key
statusstringActive / Closed
original_quota_offering_valuefloatOriginal offering value
issued_number_of_quotasfloatNumber of subscribed quotas
remaining_quota_offering_valuefloatRemaining offering value
start_datestringOffering start date
issuance_seriestringIssuance Serie object
typestringPublic/private offering type
cvm_registrationJSON *CVM registration data
lead_coordinatorJSON *Lead coordinator data
maturity_datestring *Maturity date
original_number_of_quotasstring *Number of issued quotas
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​

FieldTypeDescription
financial_application_keystringUnique financial application identification key
financial_application_event_keystringUnique financial application event identification key
typestringConsume value / Update quotas / Cancel
event_datetimestringEvent date and time
share_capitalfloat *Financial application investment value *ONLY APPEARS WHEN 'consume_value'
number_of_quotasfloat *Financial application number of quotas *ONLY APPEARS WHEN 'update_quotas'

Issuance Serie​

FieldTypeDescription
namestringIssuance serie name
issuance_serie_keystringUnique issuance serie identification key
sub_classJSONSub Class object
classificationstringProfessional / Qualified / General
market_typestringPrimary / Secondary
serieintegerReturn curve / Residual

Sub Class​

FieldTypeDescription
namestringSub class name
sub_class_keystringUnique sub class identification key
subordination_levelintSub class subordination level
fund_classJSONFund Class object

Fund Class​

FieldTypeDescription
namestringFund class name
fund_class_keystringUnique fund class identification key
document_numberstringFund class CNPJ
short_namestringFund class short name

Investor​

FieldTypeDescription
namestringInvestor name
investor_keystringUnique investor identification key
document_numberstringInvestor CPF/CNPJ
person_typestringNatural Person / Legal Person / Fund Class
distributorJSONDistributor object

Distributor​

FieldTypeDescription
namestringDistributor name
distributor_keystringUnique distributor identification key
document_numberstringDistributor CPF/CNPJ