Request Subscription Note
Introduction
This resource is used to create a request for an investor's subscription note to a fund's quota offering. From this request, the note document is generated according to the generation type configured in the offering.
Input / Output:
As input, the UUID of the quota offering the investor is subscribing to, the note value, the transaction type and, optionally, the signature method and the signer group must be sent. See the example below.
As output, the full object of the created subscription note is delivered, including the subscription_note_key. The subscription_note_key is used to identify the subscription note.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
The offering must belong to a fund of the manager. Base URL for each host: Environments (Hosts).
Request
Path Params
| Parameter | Description |
|---|---|
INVESTOR_KEY | Investor UUID |
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 offering's remaining value | Yes |
quota_offering_key | string | UUID (36 characters) of the quota offering. The offering must exist and have the 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 |
number_of_quotas | number | Number of quotas of the note. Minimum 0 | No |
start_date | string | Start date of the note (YYYY-MM-DD). If omitted, the current date (UTC) is used | No |
maturity_date | string | Maturity date of the note (YYYY-MM-DD). Cannot be in the past | No |
Signature Method
| Enumerator | Description |
|---|---|
certifiqi | Signature via CertifiQi (Digital Certificate) |
qi_sign | Signature via QI Sign (Electronic Signature) |
Response
{
"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"
}
]
}
The detailed description of the Quota Offering, Investor and Financial Application Event objects can be found on the Subscription Note Information page.
The note is created in the send_to_generate_document status when the offering generates the document internally (subscription_note_generation_type: internal) and in pending_manual_inputs when generation is external. maturity_date and original_number_of_quotas only appear in the response when filled in.
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | QIT000004 | The offering does not belong to a fund of the manager |
| 400 | QOF000020 | maturity_date is in the past |
| 400 | QOF000026 | The note value is greater than the offering's available value |
| 400 | QOF000043 | Investor registration not found |
| 400 | QOF000046 | transaction_type other than ted or b3 |
| 400 | QOF000047 | The investor's classification does not allow subscribing to the offering |
| 400 | QOF000076 | The investor already has two active notes in this offering |
| 400 | QOF000082 | The investor's registration is outdated |
| 400 | QOF000090 | The investor already has an active unsigned note in the offering's series |
| 400 | QOF000103 | The investor has no signer group (or the signer_group_key does not exist) |
| 400 | QOF000104 | The offering is exclusive and the investor is not among the allowed investors |
| 400 | QOF000130 | The investor's registration is non-operational |
| 404 | QOF000017 | Investor not found |
| 404 | QOF000019 | Quota offering not found |
| 404 | QOF000039 | The offering is not active, has expired or has no remaining value |
| 404 | QOF000053 | transaction_type is b3 and the fund class has no registered B3 account |
| 404 | QOF000073 | signature_method not found |
| 409 | QOF000025 | The investor already has a note waiting for signature in the offering's series |
| 409 | QOF000152 | The offering has an amendment waiting for approval |
Authentication, permission and host errors: see API Errors.