Request Subscription Note

Introduction

This feature aims to create a subscription note request from an investor to a quota offering of a fund. From this request, the subscription note document is generated according to the generation type configured on the offering.

Input / Output:

As input, the UUID of the quota offering the investor is subscribing to, the subscription note value, the transaction type and, optionally, the signature method and the signer group should be sent. See example below.

As output, the complete object of the created subscription note will be delivered, including the subscription_note_key. The subscription_note_key is used to identify the subscription note.

Request

ENDPOINT

/quota_offering_control/investor/INVESTOR_KEY/subscription_note

METHOD

POST

STATUS

201

Path Params

Parameter	Description
`INVESTOR_KEY`	UUID of the investor

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

Field	Type	Description	Required
`original_subscription_note_value`	number	Subscription note value. Minimum 0. Cannot exceed the remaining value of the offering	Yes
`quota_offering_key`	string	UUID (36 characters) of the quota offering. The offering must exist and have `active` status	Yes
`transaction_type`	string	`ted` or `b3`. For `b3`, the fund class must have a registered B3 account	Yes
`signature_method`	string	Signature method enumerator. If omitted, the service defines it by person type: `natural_person` → `qi_sign`, `legal_person` → `certifiqi`	No
`signer_group_key`	string	UUID (36 characters) of the signer group. If omitted, the investor's default signer group is used	No

Signature Method

Enumerator	Description
`certifiqi`	Signature via CertifiQi (Digital Certificate)
`qi_sign`	Signature via QI Sign (Electronic Signature)

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": "SENIOR",
        "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"
    }
  ]
}

The detailed description of the Quota Offering, Investor and Financial Application Event objects can be found on the Subscription Note Information page.

Introduction​

Input / Output:​

Request​

Path Params​

Request body​

Subscription Note​

Signature Method​

Response​