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.

Request

ENDPOINT

/quota_offering_control/investor/INVESTOR_KEY/subscription_note

MÉTODO

POST

STATUS

201

Path Params

Parâmetro	Descrição
`INVESTOR_KEY`	UUID 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

Campo	Tipo	Descrição	Obrigatório
`original_subscription_note_value`	number	Valor do boletim de subscrição. Mínimo 0. Não pode exceder o valor restante da oferta	Sim
`quota_offering_key`	string	UUID (36 caracteres) da oferta de cotas. A oferta deve existir e estar com status `active`	Sim
`transaction_type`	string	`ted` ou `b3`. Para `b3`, a classe de fundo precisa ter conta B3 cadastrada	Sim
`signature_method`	string	Enumerador do método de assinatura. Se omitido, o serviço define pelo tipo de pessoa: `natural_person` → `qi_sign`, `legal_person` → `certifiqi`	Não
`signer_group_key`	string	UUID (36 caracteres) do grupo de signatários. Se omitido, usa o grupo de signatários default do investidor	Não

Signature Method

Enumerador	Descrição
`certifiqi`	Assinatura via CertifiQi (Certificado Digital)
`qi_sign`	Assinatura via QI Sign (Assinatura Eletrônica)

Response

Response Body
{
  "subscription_note_key": "UUID",
  "status": "created",
  "original_number_of_quotas": 500,
  "original_subscription_note_value": 50000.00,
  "issued_number_of_quotas": 0,
  "remaining_subscription_note_value": 50000.00,
  "start_date": "YYYY-MM-DD",
  "transaction_type": "ted",
  "signature_method": "certifiqi",
  "investor": {
    "distributor": {
      "distributor_key": "UUID",
      "document_number": "00.000.000/0000-00",
      "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",
      "selected_agent": "distributor"
    }
  ]
}

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.

Introdução​

Input / Output:​

Request​

Path Params​

Request body​

Subscription Note​

Signature Method​

Response​