Retrieving Information about Offerings

---

Request

ENDPOINT

/quota_offering_control/fund_class/FUND_CLASS_KEY/quota_offerings

METHOD

GET

Warning

This resource is only available for integrations that exercise the role of Manager.

Responses

STATUS

200

Query Params

Parameter	Description
sub_class_key	Unique identification key of the sub class
issuance_serie_key	Unique identification key of the issuance series

Case 01: Fund with one Offering

{
   "data":[{
      "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",
         "data":{
            "type":"public / private",
            "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"
            },
            "original_quota_offering_value":0.00
         }
      }
   }
   ],
   "limit":50,
   "page":0,
   "is_last_page":true
}

Case 02: Fund without an Offering

{
   "data":[],
   "limit":50,
   "page":0,
   "is_last_page":true
}

Response Fields

Field	Type	Description
data	array	List of Quota Offering objects
limit	int	Limit of objects retrieved per page
page	int	Number of the retrieved page
is_last_page	boolean	Information indicating whether the retrieved page is the last

Note

TYPE

* means that the field can be null, as in the example below:

Type
string *

Quota Offering

Field	Type	Description
quota_offering_key	string	Unique identification key of the offering
status	string	Active / Closed
original_quota_offering_value	float	Original value of the offering
issued_number_of_quotas	float	Number of subscribed quotas
remaining_quota_offering_value	float	Remaining value of the offering
start_date	string	Start date of the offering
issuance_serie	string	Issuance Serie object
type	string	Type of offering public/private
cvm_registration	JSON *	CVM registration data
lead_coordinator	JSON *	Lead coordinator data
maturity_date	string *	Maturity date
original_number_of_quotas	string *	Number of issued quotas

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

Issuance Serie

Field	Type	Description
name	string	Name of the issuance series
issuance_serie_key	string	Unique identification key of the issuance series
sub_class	JSON	Sub Class object
classification	string	Professional / Qualified / General
market_type	string	Primary / Secondary
serie	integer	Yield curve / Residual

Sub Class

Field	Type	Description
name	string	Name of the sub class
sub_class_key	string	Unique identification key of the sub class
subordination_level	int	Subordination level of the sub class
fund_class	JSON	Fund Class object

Fund Class

Field	Type	Description
name	string	Name of the fund class
fund_class_key	string	Unique identification key of the fund class
document_number	string	CNPJ of the fund class
short_name	string	Short name of the fund class