Pular para o conteúdo principal

Solicitar Boletim de Subscrição


Introdução​

Este recurso tem como objetivo criar uma solicitação de boletim de subscrição de um investidor a uma oferta de cotas de um fundo. A partir desta solicitação, o documento do boletim é gerado de acordo com o tipo de geração configurado na oferta.

Input / Output:​

Como input deve ser enviado o UUID da oferta de cotas em que o investidor está subscrevendo, o valor do boletim, o tipo de transação e, opcionalmente, o método de assinatura e o grupo de signatários. Segue abaixo exemplo.

Como output será entregue o objeto completo do boletim de subscrição criado, incluindo a subscription_note_key. A subscription_note_key é utilizada para identificar o boletim de subscrição.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiEscrita

A oferta precisa ser de um fundo da gestora. URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/quota_offering_control/investor/INVESTOR_KEY/subscription_note
MÉTODO
POST
STATUS
201

Path Params​

ParâmetroDescrição
INVESTOR_KEYUUID do investidor

Request body​

Request Body
{
"original_subscription_note_value": 50000.00,
"quota_offering_key": "UUID",
"transaction_type": "ted",
"signature_method": "certifiqi",
"signer_group_key": "UUID"
}

Subscription Note​

CampoTipoDescriçãoObrigatório
original_subscription_note_valuenumberValor do boletim de subscrição. Mínimo 0. Não pode exceder o valor restante da ofertaSim
quota_offering_keystringUUID (36 caracteres) da oferta de cotas. A oferta deve existir e estar com status activeSim
transaction_typestringted ou b3. Para b3, a classe de fundo precisa ter conta B3 cadastradaSim
signature_methodstringEnumerador do método de assinatura. Se omitido, o serviço define pelo tipo de pessoa: natural_person → qi_sign, legal_person → certifiqiNão
signer_group_keystringUUID (36 caracteres) do grupo de signatários. Se omitido, usa o grupo de signatários default do investidorNão
number_of_quotasnumberQuantidade de cotas do boletim. Mínimo 0Não
start_datestringData inicial do boletim (YYYY-MM-DD). Se omitida, usa a data atual (UTC)Não
maturity_datestringData de vencimento do boletim (YYYY-MM-DD). Não pode estar no passadoNão

Signature Method​

EnumeradorDescrição
certifiqiAssinatura via CertifiQi (Certificado Digital)
qi_signAssinatura via QI Sign (Assinatura Eletrônica)

Response​

Response Body
{
"subscription_note_key": "UUID",
"status": "send_to_generate_document",
"original_number_of_quotas": 500,
"original_subscription_note_value": 50000.00,
"issued_number_of_quotas": 0,
"remaining_subscription_note_value": 50000.00,
"total_assignment_value": 0.00,
"start_date": "YYYY-MM-DD",
"transaction_type": "ted",
"signature_method": "certifiqi",
"investor": {
"distributor": {
"distributor_key": "UUID",
"document_number": "11.222.333/0001-81",
"name": "SAMPLE DISTRIBUTOR NAME"
},
"investor_key": "UUID",
"name": "SAMPLE INVESTOR NAME",
"person_type": "natural_person / legal_person",
"document_number": "00.000.000/0000-00"
},
"quota_offering": {
"quota_offering_key": "UUID",
"status": "active",
"original_quota_offering_value": 10000000.00,
"issued_number_of_quotas": 25000.00,
"remaining_quota_offering_value": 7500000.00,
"start_date": "YYYY-MM-DD",
"issuance_serie": {
"name": "1",
"issuance_serie_key": "UUID",
"external_id": "SERIE-001",
"sub_class": {
"name": "SÊNIOR",
"sub_class_key": "UUID",
"subordination_level": 1,
"fund_class": {
"fund_class_key": "UUID",
"document_number": "00.000.000/0000-00",
"name": "SAMPLE FUND CLASS NAME",
"short_name": "SAMPLE FUND CLASS SHORT NAME",
"manager": {
"name": "SAMPLE MANAGER NAME",
"manager_key": "UUID",
"document_number": "00.000.000/0000-00"
},
"administrator": {
"name": "SAMPLE ADMINISTRATOR NAME",
"administrator_key": "UUID",
"document_number": "00.000.000/0000-00",
"data": {}
},
"b3_account": "123456"
}
},
"classification": "general / qualified / professional",
"market_type": "primary / secondary",
"serie": 1,
"issuance_serie_configuration": {}
},
"type": "public / private",
"subscription_note_template_key": "UUID",
"subscription_note_generation_type": "internal / external",
"regulatory_type": "exclusive_fund",
"maturity_date": "YYYY-MM-DD",
"status_events": [
{
"status": "created",
"event_datetime": "YYYY-MM-DD HH:MM:SS"
},
{
"status": "active",
"event_datetime": "YYYY-MM-DD HH:MM:SS"
}
]
},
"financial_application_events": [],
"status_events": [
{
"status": "created",
"event_datetime": "YYYY-MM-DD HH:MM:SS"
},
{
"status": "send_to_generate_document",
"event_datetime": "YYYY-MM-DD HH:MM:SS"
}
]
}

A descrição detalhada dos objetos Quota Offering, Investor e Financial Application Event pode ser consultada na página Informações sobre Boletim de Subscrição.

O boletim é criado no status send_to_generate_document quando a oferta gera o documento internamente (subscription_note_generation_type: internal) e em pending_manual_inputs quando a geração é externa. maturity_date e original_number_of_quotas só aparecem na resposta quando preenchidos.

Erros​

StatusCódigoQuando acontece
400QIT000004A oferta não é de um fundo da gestora
400QOF000020maturity_date está no passado
400QOF000026O valor do boletim é maior que o valor disponível da oferta
400QOF000043Cadastro do investidor não encontrado
400QOF000046transaction_type diferente de ted ou b3
400QOF000047A classificação do investidor não permite subscrever a oferta
400QOF000076O investidor já tem dois boletins ativos nessa oferta
400QOF000082O cadastro do investidor está desatualizado
400QOF000090O investidor já tem um boletim ativo sem assinatura na série da oferta
400QOF000103O investidor não possui grupo de signatários (ou o signer_group_key não existe)
400QOF000104A oferta é exclusiva e o investidor não está entre os investidores permitidos
400QOF000130O investidor está com o cadastro não operacional
404QOF000017Investidor não encontrado
404QOF000019Oferta de cotas não encontrada
404QOF000039A oferta não está ativa, está vencida ou não tem valor restante
404QOF000053transaction_type é b3 e a classe de fundo não tem conta B3 cadastrada
404QOF000073signature_method não encontrado
409QOF000025O investidor já tem um boletim aguardando assinatura na série da oferta
409QOF000152A oferta tem um aditamento aguardando aprovação

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