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

Lista os boletins de subscrição de um investidor ou de uma classe de fundo, de forma paginada.

Request

Boletins de um investidor

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/quota_offering_control/investor/INVESTOR_KEY/subscription_notes

MÉTODO

GET

STATUS

200

A gestora recebe apenas os boletins de ofertas de fundos que ela gere.

Query param	Descrição
`limit`	Itens por página. Padrão 50, máximo 500
`page`	Página, começando em 0. Padrão 0
`status`	Filtra por status. Aceita mais de um valor, separados por vírgula
`issuance_serie_key`	Filtra pela série de emissão
`fund_class_document_number`	Filtra pelo CNPJ da classe de fundo
`financial_application_key`	Filtra pela aplicação financeira
`quotation_date`	Com `status=sold_off`, retorna os boletins esgotados nessa data (`YYYY-MM-DD`)

Boletins de uma classe de fundo

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/quota_offering_control/fund_class/FUND_CLASS_KEY/subscription_notes

MÉTODO

GET

STATUS

200

Query param	Descrição
`limit`	Itens por página. Padrão 50, máximo 500
`page`	Página, começando em 0. Padrão 0
`status`	Filtra por status. Aceita mais de um valor, separados por vírgula
`investor_key`	Filtra pelo investidor
`investor_document_number`	Filtra pelo CPF/CNPJ do investidor

Responses

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

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

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	Status do boletim. Ver Subscription Note Status
`signature_method`	string	`certifiqi` / `qi_sign` / `opt_in` / `external`
`total_assignment_value`	float	Valor total cedido do boletim
`status_events`	array	Histórico de status (`status`, `event_datetime`)
`transaction_type`	string	`ted` / `b3`
`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. Ausente quando não preenchida
`original_number_of_quotas`	float	Quantidade original de cotas. Ausente quando não preenchida

Subscription Note Status

Enumerador	Descrição
`created`	Criado
`pending_batch_close`	Aguardando fechamento do lote
`send_to_generate_document`	Enviado para geração do documento
`pending_document`	Aguardando documento
`pending_manual_inputs`	Aguardando dados manuais (geração externa)
`pending_signature`	Aguardando assinatura
`active_without_signature`	Ativo sem assinatura
`active`	Ativo
`sold_off`	Esgotado
`processing_cancellation`	Em cancelamento
`canceled`	Cancelado
`processing_expired`	Em expiração
`expired`	Expirado

Quota Offering

O objeto quota_offering tem os mesmos campos da resposta de Informações das ofertas, inclusive os objetos aninhados issuance_serie, sub_class e fund_class.

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. Só aparece quando `type` é `consume_value`
`number_of_quotas`	float	Número de cotas da aplicação financeira. Só aparece quando `type` é `update_quotas`

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

Erros

Status	Código	Quando acontece
400	`QIT000004`	A classe de fundo não é gerida pela gestora
404	`QOF000007`	Classe de fundo não encontrada
404	`QOF000017`	Investidor não encontrado

Erros de autenticação, permissão e host: veja Erros da API.

Request​

Boletins de um investidor​

Boletins de uma classe de fundo​

Responses​

Response Fields​

Subscription Note​

Subscription Note Status​

Quota Offering​

Financial Application Event​

Investor​

Distributor​

Erros​