Retrieving Information about Offerings

---

Lists the quota offerings of a fund class, in paginated form.

Available on

Profile	Host	Required permission
Manager	manager-api	Read

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/quota_offering_control/fund_class/FUND_CLASS_KEY/quota_offerings

METHOD

GET

STATUS

200

Query Params

Parameter	Description
limit	Items per page. Default 50, maximum 500
page	Page, starting at 0. Default 0
sub_class_key	Unique identification key of the sub class
issuance_serie_key	Unique identification key of the issuance series
showOffers	active: only active offerings with remaining value. closed: closed offerings or offerings with a maturity date in the past

Responses

Case 01: Fund with one Offering

{
   "data":[
      {
         "quota_offering_key":"UUID",
         "status":"active",
         "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",
         "subscription_note_template_key":"UUID",
         "subscription_note_generation_type":"internal / external",
         "regulatory_type":"exclusive_fund",
         "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"
         },
         "status_events":[
            {
               "status":"active",
               "event_datetime":"YYYY-MM-DD HH:MM:SS"
            }
         ]
      }
   ],
   "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	Indicates whether the retrieved page is the last one

Quota Offering

Field	Type	Description
quota_offering_key	string	Unique identification key of the offering
status	string	created / active / processing_closing / pending_closing_at_cvm / pending_closing_at_anbima / pending_divulgation / closed
subscription_note_generation_type	string	internal (document generated by QI) / external
subscription_note_template_key	string	Key of the subscription note template
regulatory_type	string	Regulatory type of the offering
status_events	array	Status history (status, event_datetime)
original_quota_offering_value	float	Original offering value
issued_number_of_quotas	float	Number of subscribed quotas
remaining_quota_offering_value	float	Remaining offering value
start_date	string	Offering start date
issuance_serie	string	Issuance Serie object
type	string	Public/private offering type
cvm_registration	JSON	CVM registration data. Absent when not filled in
lead_coordinator	JSON	Lead coordinator data. Absent when not filled in
maturity_date	string	Maturity date. Absent when not filled in
original_number_of_quotas	float	Original number of quotas. Absent when not filled in

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	Issuance series name
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	Sequential number of the issuance series within the sub class (1, 2, 3...). Not repeated within the same sub class

Sub Class

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

Fund Class

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

Errors

Status	Code	When it happens
400	QIT000004	The fund class is not managed by the manager
404	QOF000007	Fund class not found

Authentication, permission and host errors: see API Errors.