Recuperando Informações sobre Boletim de Subscrição

Request

ENDPOINT

/quota_offering_control/investor/INVESTOR_KEY/subscription_notes

MÉTODO

GET

Responses

STATUS

200

Caso 01: Investidor com um Boletim de Subscrição

{
   "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
}

Caso 02: Investidor sem Boletim de Subscrição

{
   "data":[],
   "limit":50,
   "page":0,
   "is_last_page":true
}

Response Fields

Campo	Tipo	Descrição
`data`	array	Lista de objetos de Subscription Note
`limit`	int	Limite de objetos recuperados por página
`page`	int	Número da página recuperada
`is_last_page`	boolean	Informação que indica se a página recuperada é a última

Observação

TIPO

* significa que o campo pode ser nulo, como no exemplo abaixo:

Tipo
string *

Subscription Note

Campo	Tipo	Descrição
`subscription_note_key`	string	Chave única de identificação do boletim de subscrição
`quota_offering`	JSON	Objeto de Quota Offering
`investor`	JSON	Objeto de Investor
`status`	string	Enviar para gerar documento / Pendente documento / Pendente assinatura / Cancelado / Ativo / Esgotado
`transaction_type`	string	B3 / TED
`original_subscription_note_value`	float	Valor original do boletim de subscrição
`issued_number_of_quotas`	float	Quantidade de cotas emitidas
`remaining_subscription_note_value`	float	Valor restante do boletim de subscrição
`start_date`	string	Data inicial do boletim de subscrição
`financial_application_events`	array	Lista de objetos de Financial Application Event
`maturity_date`	string*	Data de vencimento
`original_number_of_quotas`	string*	Número do cotas emitidas

Quota Offering

Campo	Tipo	Descrição
`quota_offering_key`	string	Chave única de identificação da oferta
`status`	string	Ativa / Fechada
`original_quota_offering_value`	float	Valor original da oferta
`issued_number_of_quotas`	float	Quantidade de cotas subscritas
`remaining_quota_offering_value`	float	Valor restante da oferta
`start_date`	string	Data inicial da oferta
`issuance_serie`	string	Objeto de Issuance Serie
`type`	string	Tipo da oferta pública/privada
`cvm_registration`	JSON *	Dados do registro CVM
`lead_coordinator`	JSON *	Dados do coordenador líder
`maturity_date`	string *	Data de vencimento
`original_number_of_quotas`	string *	Número do cotas emitidas

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

Campo	Tipo	Descrição
`financial_application_key`	string	Chave única de identificação da aplicação financeira
`financial_application_event_key`	string	Chave única de identificação do evento da aplicação financeira
`type`	string	Consumir valor / Atualizar cotas / Cancelar
`event_datetime`	string	Data e hora do evento
`share_capital`	float *	Valor do aporte da aplicação financeira *SOMENTE APARECE QUANDO FOR 'consume_value'
`number_of_quotas`	float *	Número de cotas da aplicação financeira *SOMENTE APARECE QUANDO FOR 'update_quotas'

Issuance Serie

Campo	Tipo	Descrição
`name`	string	Nome da série de emissão
`issuance_serie_key`	string	Chave única de identificação da série de emissão
`sub_class`	JSON	Objeto de Sub Class
`classification`	string	Profissional / Qualificado / Geral
`market_type`	string	Primário / Secundário
`serie`	integer	Curva de rendimento / Residual

Sub Class

Campo	Tipo	Descrição
`name`	string	Nome da sub classe
`sub_class_key`	string	Chave única de identificação da sub classe
`subordination_level`	int	Nível de subordinação da sub classe
`fund_class`	JSON	Objeto de Fund Class

Fund Class

Campo	Tipo	Descrição
`name`	string	Nome da classe de fundo
`fund_class_key`	string	Chave única de identificação da classe de fundo
`document_number`	string	CNPJ da classe de fundo
`short_name`	string	Nome reduzido da classe de fundo

Investor

Campo	Tipo	Descrição
`name`	string	Nome do investidor
`investor_key`	string	Chave única de identificação do investidor
`document_number`	string	CPF/CNPJ do investidor
`person_type`	string	Pessoa Física / Pessoa Jurídica / Classe de Fundo
`distributor`	JSON	Objeto de Distributor

Distributor

Campo	Tipo	Descrição
`name`	string	Nome do distribuidor
`distributor_key`	string	Chave única de identificação do distribuidor
`document_number`	string	CPF/CNPJ do distribuidor

Recuperando Informações sobre Boletim de Subscrição

Request​

Responses​

Response Fields​

Observação​

Subscription Note​

Quota Offering​

Financial Application Event​

Issuance Serie​

Sub Class​

Fund Class​

Investor​

Distributor​