Generic Deal¶
The generic deal endpoints provide a way to access deal data using an asset class agnostic view. All asset classes and deal types can be accessed and only those data fields that are applicable to all deal types will be returned.
It is expected that these endpoints are used to provide functionality where searches and data views are required across various asset classes, for example to show complete calendars of all current deals. The generic deal endpoints are also used to delete deals or to make lightweight calls to get deal information when only certain fields are required, such as id and description. Deals cannot be created at the generic level, in order to create deals you must use the relevant deal type endpoint.
API Endpoints¶
The full list of available API endpoints is show below, with links to the detailed documentation for each. For a concise, structured definition please reference the Swagger/Open API specification.
Name |
Method |
Url |
Description |
Get |
/v1/deals |
Get all deals with optional search criteria |
|
Get |
/v1/deals/{id} |
Get a specific deal |
|
Delete |
/v1/deals/{id} |
Delete a specific deal |
|
Delete |
/v1/deals |
Delete a specific deal by source application id |
Get Deals¶
The get deals endpoint provides a way of accessing a collection of deal objects based on the input parameters.
Parameters¶
The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.
Name |
Type |
Format |
Description |
Default |
page |
integer |
Querystring |
See Pagination |
1 |
pageSize |
integer |
Querystring |
See Pagination |
250 |
sourceId |
string |
Querystring |
A comma delimited list of source ids to search for |
null |
criteria |
array[object] |
Querystring |
See Search Criteria |
null |
accessType |
string |
Querystring |
A comma delimited list of Access Type. |
Private |
sortField |
string |
Querystring |
See Sort |
|
sortDirection |
string |
Querystring |
See Sort |
Asc |
Response¶
The endpoint returns a json payload containing an paginated array of Deal Object. The pagination is in the standard CAS format as described in Pagination.
Get Deal¶
The get deal endpoint provides a way of accessing a specific deal object by id.
Authorization¶
In order to access the deal information, it is required to have the deals-read scope in the access token.
Parameters¶
The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.
Name |
Type |
Format |
Description |
Default |
id |
UUID |
URL path |
The unique CAS id of the deal to retrieve |
Response¶
The endpoint returns a json payload containing a Deal Object.
Delete Deal¶
The delete deal endpoint provides a way of deleting a specific deal object by id.
Authorization¶
In order to delete the deal, it is required to have the deals-write scope in the access token.
Parameters¶
The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.
Name |
Type |
Format |
Description |
Default |
id |
UUID |
URL path |
The unique CAS id of the deal to delete |
Response¶
The endpoint returns an http response code indicating the success or failure of the action.
Delete Deal by Source Id¶
This delete deal endpoint provides a way of deleting a specific deal object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.
Authorization¶
In order to delete the deal, it is required to have the deals-write scope in the access token.
Parameters¶
The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.
Name |
Type |
Format |
Description |
Default |
sourceId |
string |
Querystring |
A source id to delete |
null |
Response¶
The endpoint returns an http response code indicating the success or failure of the action.
Schema¶
The generic deal object builds on the common structure described in Common Structure and extends it with properties that apply to all asset classes. This deal object structure is shown below, and underneath the json example, each element is described in detail.
Example json¶
{
"series": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"globalId": "string",
"sourceId": "string",
"name": "string",
"description": "string",
"amount": 0,
"quantity": 0,
"trancheIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"trancheNames": [
"string"
],
"notes": "string",
"documents": [
{
"visibility": "Internal",
"clientDocumentType": "string",
"name": "string",
"url": "string",
"id": "string",
"createdDateTime": "2021-04-09T14:07:51.312Z",
"lastModifiedDateTime": "2021-04-09T14:07:51.312Z"
}
]
}
],
"products": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceId": "string",
"dealId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"name": "string",
"securityType": "string",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-09T14:07:51.311Z",
"status": "UnderReview"
}
],
"redemptionOptions": [
{
"description": "string",
"type": "Callable",
"frequency": "Annual",
"firstDate": "2021-04-09T14:07:51.311Z",
"firstPrice": 0,
"lastDate": "2021-04-09T14:07:51.311Z",
"lastPrice": 0,
"maxPrice": 0,
"priceIncrement": 0,
"schedule": [
{
"date": "2021-04-09T14:07:51.311Z",
"price": 0
}
],
"notes": "string"
}
],
"filings": [
{
"identificationCodes": [
{
"type": "Symbol",
"code": "string"
}
],
"settlement": {
"location": "string",
"currency": "string",
"date": "2021-04-09T14:07:51.311Z"
},
"registration": {
"country": "string",
"rules": [
"Rule144"
],
"type": "Exempt"
},
"isDefault": true,
"structure": "ClassicGlobalNote",
"form": "Bearer",
"governingLaw": [
"Irish"
],
"tefra": "C"
}
],
"version": 0,
"displayOrder": 0,
"isBase": true,
"exchanges": [
"string"
],
"fees": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lastSalePrice": 0,
"productConversionRatio": "string",
"expectedGrossSpread": "string",
"expectedIncentiveFee": "string",
"discountLimitReferencePrice": 12.23
}
],
"tranches": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceId": "string",
"dealId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"status": "Live",
"sectors": [
"string"
],
"indicators": [
"string"
],
"productIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"amount": 0,
"quantity": 0,
"underwritingEntity": {
"name": "string",
"firmId": 0,
"pmId": "string"
},
"orderAttestation": "string",
"globalId": "string",
"displayOrder": 0,
"notes": "string",
"statusDescription": "string",
"version": 0,
"syndicate": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"roles": [
"GlobalCoordinator"
],
"role": "GlobalCoordinator",
"brackets": [
{
"id": 0,
"name": "string",
"displayOrder": 0
}
],
"pmId": "string",
"isBookBuilder": true,
"internalId": "string",
"feeDistributions": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lei": "string"
}
],
"contacts": [
{
"firstName": "string",
"lastName": "string",
"email": "string",
"type": "CapitalMarketsContact"
}
],
"effectiveDateTime": "2021-04-09T14:07:51.312Z",
"offerDate": "2021-04-09T14:07:51.312Z",
"pricingDateTime": "2021-04-09T14:07:51.312Z",
"settlementDate": "2021-04-09T14:07:51.312Z",
"settlementDateOffset": 0,
"fileValue": {
"amount": 0,
"type": "Quantity"
},
"greenShoeOverAllotmentValue": {
"amount": 0,
"type": "Quantity"
},
"currentFileValue": {
"amount": 0,
"type": "Quantity"
},
"certifications": [
{
"type": "Green",
"verifier": "Self",
"preApproved": true,
"esgComments": "string"
}
],
"comments": "string",
"isBase": true,
"expectedValue": {
"amount": "string",
"type": "Quantity"
},
"trancheComments": [
{
"type": "General",
"text": "string"
}
],
"collaborationBookState": "string",
"expectedBookClose": "2021-04-09T14:07:51.312Z",
"expectedBookCloseTimeZone": "AlphaTimeZone"
}
],
"firmId": 0,
"version": 0,
"sourceId": "string",
"assetClassType": "None",
"dealType": "None",
"currency": "string",
"amount": 0,
"details": "string",
"globalId": "string",
"code": "string",
"description": "string",
"quantity": 0,
"syndicate": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"roles": [
"GlobalCoordinator"
],
"role": "GlobalCoordinator",
"brackets": [
{
"id": 0,
"name": "string",
"displayOrder": 0
}
],
"pmId": "string",
"isBookBuilder": true,
"internalId": "string",
"feeDistributions": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lei": "string"
}
],
"contacts": [
{
"firstName": "string",
"lastName": "string",
"email": "string",
"type": "CapitalMarketsContact"
}
],
"issuer": {
"name": "string",
"country": "string",
"description": "string",
"sector": "string",
"ticker": "string",
"cusipBase": "string",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-09T14:07:51.312Z",
"status": "UnderReview"
}
],
"firmId": 0,
"marketCap": {
"amount": 0,
"currency": "string"
},
"pmId": "string",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
],
"industryClassification": {
"industryGroup": "Energy",
"industry": "RenewableEnergyEquipmentandServices",
"subIndustry": "RenewableEnergyEquipmentandServices"
}
},
"methodOfSale": "Negotiated",
"players": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"role": "Obligor",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
]
}
],
"fileDate": {
"date": "2021-04-09T14:07:51.312Z",
"qualifier": "Date"
},
"launchDate": {
"date": "2021-04-09T14:07:51.312Z",
"qualifier": "Date"
},
"indicators": [
"string"
],
"createdBy": "string",
"createdTimeStamp": "2021-04-09T14:07:51.312Z",
"lastModifiedBy": "string",
"lastModifiedTimeStamp": "2021-04-09T14:07:51.312Z",
"lastModifiedByFirmId": "string",
"accessType": "Private",
"notes": "string",
"dealStatus": "Active",
"effectiveDateTime": "2021-04-09T14:07:51.312Z",
"offerDate": "2021-04-09T14:07:51.312Z",
"pricingDateTime": "2021-04-09T14:07:51.312Z",
"settlementDate": "2021-04-09T14:07:51.312Z",
"settlementDateOffset": 0,
"expectedValue": {
"amount": "string",
"type": "Quantity"
},
"fileValue": {
"amount": 0,
"type": "Quantity"
},
"postOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"greenShoeOverAllotmentValue": {
"amount": 0,
"type": "Quantity"
},
"currentFileValue": {
"amount": 0,
"type": "Quantity"
},
"primaryOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"secondaryOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"comments": [
{
"type": "General",
"text": "string"
}
],
"blueSky": [
{
"countryCode": "USA",
"stateCode": [
"AL"
],
"status": "NotCleared"
}
],
"effectiveDateTimeZone": "AlphaTimeZone",
"pricingDateTimeZone": "AlphaTimeZone",
"managementType": "SoleManaged",
"documents": [
{
"visibility": "Internal",
"clientDocumentType": "string",
"name": "string",
"url": "string",
"id": "string",
"createdDateTime": "2021-04-09T14:07:51.312Z",
"lastModifiedDateTime": "2021-04-09T14:07:51.312Z"
}
],
"fxRates": {
"filing": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
],
"offering": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
],
"settlement": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
]
},
"transactionalData": {
"created": {
"byFirm": {
"lei": "string",
"pmid": "string"
},
"dateTime": "2021-04-09T14:07:51.312Z"
}
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
}
Deal Object¶
- id
The unique identifier of the deal in UUID format. This is a read only value generated by the CAS system.
- sourceId
The identifier of the deal from a source application, if applicable.
- globalId
An identifier that links multiple deals in the CAS system together if they represent a single deal in the market. An example of this is a syndicated deal - each Bank will have their own deal copy, but a single globalId will link them together. The globalId can be any string value and may be generated by other systems.
- code
A short code that identifies the deal.
- name
A short human readable name that identifies the deal and is used to link entities together within the deal (such as tranches) before ids have been generated.
- description
A human readable description of the deal.
- accessType
The access type of the deal. See Access Type for full details.
- assetClassType
An identifier of the asset class of the deal. Valid values are
FixedIncome
orEquity
. This is a read only value generated by the CAS system depending on the endpoint used to create the deal.- dealType
An identifier of the specific deal type within the asset class. This is a read only value generated by the CAS system depending on the endpoint used to create the deal. Valid identifiers for each asset class are shown below:
Asset Class
Deal Types
Fixed Income
StandardBond, Municipal
Equity
CommonStock
- issuer
An object that contains information about the issuer of the deal. For full details see Issuer Object.
- currency
The currency of the deal in ISO 4217 format.
- amount
The size of the deal in monetary value.
- quantity
The size of the deal in quantity of securities.
- dealStatus
The current status of the deal. Valid values are
Active
,Cancelled
,Postponed
,NotBought
orBought
.- details
The URL of the full deal record for this asset class and deal type to enable deep linking to the full deal details. This is a read only field generated by the CAS system.
- methodOfSale
The underwriting sale method of the deal. Valid values are
Negotiated
,Competitive
orPrivatePlacement
.- players
An array of objects containing the details of the non-syndicating players on the deal. For full details see Player Object.
- fileDate
A complex type showing the date of filing of the deal. For full details see Complex Date Object.
- launchDate
A complex type showing the date of the launch of the deal. For full details see Complex Date Object.
- indicators
An array of indicators to categorize the deal. These indicators are free text.
- createdBy
The CAS UUID of the user that created the deal. This can be overridden by API consumers and represents the user who initiated the request, but a separate audit trail is kept internally that tracks real time audit information.
- createdTimeStamp
The timestamp the deal was created. This can be overridden by API consumers but a separate audit trail is kept internally that tracks real time audit information.
- lastModifiedBy
The CAS UUID of the user that last modified the deal. This can be overridden by API consumers and represents the user who initiated the request, but a separate audit trail is kept internally that tracks real time audit information.
- lastModifiedTimeStamp
The timestamp the deal was last modified. This can be overridden by API consumers but a separate audit trail is kept internally that tracks real time audit information.
- lastModifiedByFirmId
Represents the Firm Id of the Caller that last modified the Deal.
- syndicate
The details of the members of the syndicate at the deal level, if applicable. For full details see Syndicate Object.
- notes
A free text area for notes to be attached to the deal.
- contacts
Deal level Contacts. For full details see Contacts Object.
- effectiveDateTime
The date and time when a security goes into the secondary market. (UTC) First Day a stock trades.
- effectiveDateTimeZone
Information relayed on date/time fields if it is required to denote a specific time zone. For the list of valid values see Time Zone Names.
- offerDate
The date the deal gets priced and first date when available in the primary market.
- pricingDateTime
The date and time when the deal is priced.
- pricingDateTimeZone
Information relayed on date/time fields if it is required to denote a specific time zone. For the list of valid values see Time Zone Names.
- settlementDate
The date of the Settlement.
- settlementDateOffset
The number of business days after the execution date on which the trade is final.
- FileValue
A complex type describing the deal size filed with the SEC. Deal size will not rollup from the tranches. For full details see Complex Amount Object.
- ExpectedValue
A complex type describing the expected value. For full details see Complex Amount Text Object.
- postOfferingValue
A complex type describing the numeric value to identify number of shares currently in public circulation. For full details see Complex Amount Object.
- GreenShoeOverAllotmentValue
A complex type describing the percent of deal size available for overallotment option. For full details see Complex Amount With Percentage Object.
- CurrentFileValue
A complex type describing the current file size - offerings are filed with the SEC with sizes. For full details see Complex Amount Object.
- PrimaryOfferingValue
Syndicate has a control over splitting of the deal size between primary & secondary shares.This field represents the primary set and it is a complex type. For full details see Complex Amount Object.
- SecondaryOfferingValue
Syndicate has a control over splitting of the deal size between primary & secondary shares.This field represents the secondary set and it is a complex type. For full details see Complex Amount Object.
- series
An array of objects containing the Series level information. For full details see Series Object.
- tranches
An array of objects containing the Tranche level information. For full details see Tranche Object.
- products
An array of objects containing the Product level information. For full details see Product Object.
- blueSky
The “Blue Sky” law is the term given to the laws governing transactions involving state securities. For full details see Blue Sky Object.
- managementType
Determines whether the deal is Sole Managed or Syndicated. This is an enum and the allowed values are SoleManaged or Syndicated.
- documents
Gives a Syndicate user the ability to add an array of Deal Documents with their visibility, clientDocumentType, name, url, id, createdDateTime, lastModifiedDateTime. For Visibility, the valid enum values are
External
andInternal
. Id is the identification code for the document, createdDateTime is the date and time in which the document was attached to the deal, and lastModifiedDateTime is the date and time in which the document was last modified. The remaining are free-text strings.- fxRates
Includes all currencies on the deal with corresponding fx rates that are set at filing, offering, and settlement of the deal.For full details see FX Rates Object.
- comments
This is to capture comments of specific types on a deal level. It’s an optional field, but if specified, it should contain both type and text. For full details see Comments.
- transactionalData
It includes information on who created/last modified the deal and when the deal was created or last modified. It is nullable. For full details see TransactionalData Object.
Contacts Object¶
- firstName
First name of the Contact.
- lastName
Last name of the Contact.
Email of the Contact.
- type
Type of the Contact.
Series Object¶
- id
The unique identifier of the series in UUID format. This is a read only value generated by the CAS system.
- sourceId
The identifier of the series from a source application, if applicable.
- globalId
An identifier that links multiple series in the CAS system together. The globalId can be any string value and may be generated by other systems.
- name
A short human readable name that identifies the series and is used to link entities together within the deal before ids have been generated.
- description
A human readable description of the series.
- amount
The size of the series in monetary value.
- quantity
The size of the series in quantity of securities.
- notes
A free text area for notes to be attached to the series.
- trancheIds
An array of tranche CAS UUID identifiers showing which tranches are included in this series. This is generated by the CAS system after tranche entities have been added.
- trancheNames
An array of tranche names showing which tranches are included in this series. This is input only data used to associated new tranches with a series, before those tranches are generated ids. Once the input data has been processed, this field is not shown on subsequent GET requests.
- documents
Gives a Syndicate user the ability to add an array of Deal Documents with their visibility, clientDocumentType, name, url, id, createdDateTime, lastModifiedDateTime. For Visibility, the valid enum values are
External
andInternal
. Id is the identification code for the document, createdDateTime is the date and time in which the document was attached to the deal, and lastModifiedDateTime is the date and time in which the document was last modified. The remaining are free-text strings.
Tranche Object¶
- id
The unique identifier of the tranche in UUID format. This is a read only value generated by the CAS system.
- sourceId
The identifier of the tranche from a source application, if applicable.
- dealId
The unique identifier of the deal this tranche belongs to. This is a read only value generated by the CAS system.
- globalId
An identifier that links multiple tranches in the CAS system together. An example of this is a syndicated deal - each Bank will have their own deal and tranches copy, but a single globalId will link them together. The globalId can be any string value and may be generated by other systems.
- name
A short human readable name that identifies the tranche and is used to link entities together within the deal before ids have been generated.
- comments
The Comments field is a text field and has a character limit of 2000
- certifications
An Array of certifications. For full details see Certification Object.
- contacts
Tranche level Contacts. For full details see Contacts Object.
- effectiveDateTime
The date and time when a security goes into the secondary market. (UTC) First Day a stock trades.
- offerDate
The date the deal gets priced and first date when available in the primary market.
- pricingDateTime
The date and time when the deal is priced.
- settlementDate
The date of the Settlement.
- settlementDateOffset
The number of business days after the execution date on which the trade is final.
- FileValue
A complex type describing the deal size filed with the SEC. Deal size will not rollup from the tranches. For full details see Complex Amount Object.
- GreenShoeOverAllotmentValue
A complex type describing the percent of deal size available for overallotment option. For full details see Complex Amount With Percentage Object.
- CurrentFileValue
A complex type describing the current file size - offerings are filed with the SEC with sizes. For full details see Complex Amount Object.
- status
An indicator showing the status of the tranche. Valid values are
Live
,Allocated
,Priced
,Settled
,Postponed
,Withdrawn
,FinalSettled
orConfidential
.- statusDescription
A free text field containing a human readable description of the tranche status. This can be any value, and is not used to trigger any access logic, but is for informational purposes only.
- amount
The size of the tranche in monetary value.
- quantity
The size of the tranche in quantity of securities.
- sectors
An array of sectors this tranche applies to. These sectors are free text.
- indicators
An array of indicators to categorize the tranche. These indicators are free text.
- orderAttestation
The Order Attestation of the tranche
- displayOrder
A numerical ordering suggesting the correct display order of the tranches in the deal.
- underwritingEntity
A complex object that contains the information of the legal entity within the owning company that will be underwriting this tranche. For full details see UnderwritingEntity Object.
- notes
A free text area for notes to be attached to the series.
- isBase
The default tranche, which shows up first across all pages of EBB.
- productIds
An array of product CAS UUID identifiers showing which products are included in this tranche. This is generated by the CAS system after tranche entities have been added.
- productNames
An array of product names showing which products are included in this tranche. This is input only data used to associated new products with a tranche, before those products are generated ids. Once the input data has been processed, this field is not shown on subsequent GET requests.
- trancheComments
This is to capture comments of specific types on a tranche level. It’s an optional field, but if specified, it should contain both type and text. For full details see Comments.
- collaborationBookState
Allows syndicate to set desired book state value for the Issuer, Investor Firms, and other Broker-Dealer Firms working on the deal.
- expectedBookClose
Represents the Date and Time when the syndicate is expected to close the Book.
- expectedBookCloseTimeZone
Represents the time zone of ExpectedBookClose date/time, if specified. For the list of valid time zones, please see Time Zone Names.
Certification Object¶
- type
Field will convey the type of ESG issue and valid values are
Green
,Climate
,Social
,Sustainable
,Blue
,Transition
,SustainabilityLinked
,Sustainability
.- verifier
Field will convey which agency has deemed issue’s ESG classification Valid Values are
Self
,Kestrel
,EY
,BAMGreenStar
,FirstEnvironmental
.- preApproved
On Competitive deals, the ESG verifier will pre-approve the deal. This field indicates if the deal was pre-approved or not. This information is applicable pre-sale of a Competitive deal.
- esgComments
Comments on the selected ESG Type and has a character limit of 2000.
UnderwritingEntity Object¶
- name
The name of the underwriting entity.
- firmId
The unique IHS Markit identifier of the underwriting entity.
- pmid
The Primary Market Identifier (PMID) of the underwriting entity, if one exists.
Product Object¶
- id
The unique identifier of the product in UUID format. This is a read only value generated by the CAS system.
- sourceId
The identifier of the product from a source application, if applicable.
- dealId
The unique identifier of the deal this product belongs to. This is a read only value generated by the CAS system.
- name
A short human readable name that identifies the tranche and is used to link entities together within the deal before ids have been generated.
- filings
A complex type describing the various filing requirements and information For full details see Filings Object.
- currency
The currency of the product in ISO 4217 format, if different to the deal.
- securityType
The specific type of the security (e.g. Bond, Note, Common Units, etc.)
- ratings
An array of objects that contains the agency ratings for this product, if they exist. Each entry in the array contains the ratings from one agency. For full details see Ratings Object.
- redemptionOption
A complex object containing the information for any Redemption Option. For full details see Redemption Option Object.
- displayOrder
Optional order in which the product is displayed.
- isBase
Optional indicator of the base product in the deal.
- exchanges
An array of values showing the exchange(s) the security is listed on. Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.
- fees
An array of complex objects containing product fees. For full details see Fee Object.
- lastSalePrice
Last sale price of the product, decimal.
- productConversionRatio
The ratio will be used to convert Secondary Products to Base Products to display total demand in Base Product to both the Sales User and the Syndicate User.
- expectedGrossSpread
Expected gross spread gives an approximation of what the gross spread will be for a deal. It is entered during the deal creation/filing.
- expectedIncentiveFee
Expected incentive fee gives an approximation of what the incentive fee will be for a deal. It is entered during the deal creation/filing.
- discountLimitReferencePrice
Discount Limit Reference Price is a price used to calculate the limit if the Investor sets it as a discount percent
Issuer Object¶
- name
The name of the issuer.
- country
The country of the Issuer.
- description
A description of the Issuer.
- sector
The industry sector of the Issuer.
- ticker
The ticker code of the issuer, if one exists.
- cusipBase
The base CUSIP code for the issuer.
- ratings
An array of objects that contains the agency ratings for the issuer, if they exist. Each entry in the array contains the ratings from one agency. For full details see Ratings Object.
- firmId
The unique IHS Markit identifier of the issuer company.
- pmId
The Primary Market Identifier (PMID) of the issuer, if one exists.
- lei
Legal Entity Identifier for the Issuer. This is used when searching for an issuer to ensure that the correct issuer is selected.
- identifications
Unique identifier for an entity. For full details see Identifications Object.
- industryClassification
IndustryClassification is used to categorize the Industry levels representing specific business activities associated to the Issuer. The Industry level values include: Industry Group, Industry, Sub-Industry. For full details see Industry Classification Object.
Ratings Object¶
- agency
An identifier of the agency the produced the rating. Valid values are
StandardAndPoors
,Moodys
,Fitch
,DuffAndPhelps
orKroll
.- longTerm
The long term rating. The format of the rating is dependent on the rating agency.
- shortTerm
The short term rating. The format of the rating is dependent on the rating agency.
- outlook
The outlook for the direction of the rating. The format of the outlook is dependent on the rating agency.
- finality
An indicator showing the state of the finality of the rating. Valid values are
Final
orExpected
.- status
An indicator showing the status of the rating. Example values could be
Rated
orExpected
.
Identifications Object¶
- id
Value of the identifier.
- source
Name of the identifier.
Player Object¶
- name
The company name of the players.
- firmId
The unique IHS Markit identifier of the company.
- shortName
An abbreviated company name of the player.
- role
The role of the player on the deal. Valid values are
Obligor
,BondCounsel
,FinancialAdvisor
,Printer
,RemarketingAgent
,UnderwritingCounsel
,Underwriter
,DeskAdministrator
orPayingAgent
.- lei
Legal Entity Identifier for the Guarantor.
- identifications
Unique identifier for an entity. For full details see Identifications Object.
Syndicate Object¶
- name
The company name of the syndicate member.
- firmId
The unique IHS Markit identifier of the company.
- shortName
An abbreviated company name of the syndicate member.
- roles
An array of roles of the player on the deal. Valid values are
GlobalCoordinator
,SoleBookrunner
,ActiveBookrunner
,PassiveBookrunner
,JointBookrunner
,JointLeadManager
,SeniorManager
,SoleLead
,SeniorCoLeadManager
,JuniorCoLeadManager
,CoLeadManager
,SeniorCoManager
,JuniorCoManager
,CoManager
,SellingGroup
,StructuringAdvisor
,NonMember
,Member
,Underwriter
,LeadManagerBookrunner
,Owner
,EsgStructuringAdvisor
orGreenStructuringAdvisor
.- role
The role of the player on the deal. Valid values are
GlobalCoordinator
,SoleBookrunner
,ActiveBookrunner
,PassiveBookrunner
,JointBookrunner
,JointLeadManager
,SeniorManager
,SoleLead
,SeniorCoLeadManager
,JuniorCoLeadManager
,CoLeadManager
,SeniorCoManager
,JuniorCoManager
,CoManager
,SellingGroup
,StructuringAdvisor
,NonMember
,Member
,Underwriter
,LeadManagerBookrunner
,Owner
,EsgStructuringAdvisor
orGreenStructuringAdvisor
.- pmid
The Primary Market Identifier (PMID) of the syndicate member, if one exists.
- lei
Legal Entity Identifier for the Syndicate.
- isBookBuilder
A boolean flag indicating if the syndicate member is a book building member of the syndicate.
- internalId
The internal identifier for banks to identify syndicate entities.
- brackets
A complex type containing the brackets of the syndicate entities. For full details see Brackets Object.
- feeDistributions
An array of complex types containing the fee breakdown, normally by percent, for the syndicate entities. For full details see FeeDistributions Object.
Brackets Object¶
- id
An integer that tell you the bracket number.
- name
The name of the bracket.
- displayOrder
The underwriter’s priority in the bracket.
FeeDistributions Object¶
- type
The fee type that is representative in the distribution. Valid values are
GlobalCoordinator
,GrossSpread
,InternalSellingConcession
,SellingConcession
,IncentiveFee
,ManagementFee
,ManagersPraecipium
,Reallowance
,Underwriting
,Pot
.- amount
Filings Object¶
- identificationCodes
An array of identification codes to identify the security. For full details see IdentificationCodes Object.
- registration
A complex type containing the registration details for this security. For full details see Registration Object.
- registrationRules
An array of rules that can be applied to the security registration. Valid values are
Rule144
,Rule144A
,Rule144AWithRegRights
,Rule3C7
,Rule415
,Rule424
,MJDS
,RegulationD
,RegulationS
,RegulationSBearer
,FormS1
,FormS2
,FormS3
,FormS11
,FormF1
,FormF2
,FormF3
,FormF6
,FormF8
,FormF9
,FormF10
,FormF80
,Form8A
,FormN2
,FormSB
,FormSB1
,FormSB2
,SecRegistered
,SecExempt
,Rule3A2Exempt
,AccreditedInvestors
,Global
,PrivatePlacement
,Domestic
,Eurobond
,Rule_4A2
,Rule_OneHalf
,Rule144ARegSWithRegRights
,Rule144ARegSWithoutRegRights
,Rule144AWithoutRegRights
,RegSWithRegRights
,RegSWithoutRegRights
,Rule144A3C7RegS
.- settlement
A complex object describing the settlement details for this security. For full details see Settlement Object.
- tefra
Part of the US Tax Equity & Fiscal Responsibility Act (TEFRA), the TEFRA regulations requires a local government issuer to satisfy an approval process prior to issuing tax exempt bonds.
- structure
The holding structure for the bond with values of CGN (Classic Global Note), CSS (Classic Safeguarding Structure), NGN (New Global Note), NSS (New Safeguarding Structure) Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.
- governingLaw
The law of the land where the bond is issued. Valid enum values are
Irish
,English
,French
,German
,NewYorkState
,Dutch
,Australian
,Delaware
,Luxemburg
,Italian
,Spanish
,Portuguese
,Norway
,Minnesota
,HongKong
,Finnish
,Belgian
,Austrian
,Canadian
,ProvinceOfOntario
,Swedish
,Slovenian
,Swiss
,Mexico
,Turkish
,Argentina
,Danish
,Japanese
,NewSW
,Slovak
,Singapore
,Quebec
- form
Identifies the owner of the Bond. For eg, a Registered bond has its owner’s name and contact information recorded with the issuing entity, ensuring coupon payments are correctly distributed. A Bearer form security is one that has no records of ownership in the issuer’s books and the only evidence of ownership is physical possession of the certificate. Valid values are
Bearer
,BearerDefinitivesAvailable
,BearerDefinitivesWillNotBePrinted
,BearerDematerialised
,BearerAndRegistered
,Registered
orTargetedRegister
. Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.
IdentificationCodes Object¶
- type
The type of identification code. Valid values are
Symbol
,CUSIP
,ISIN
,SEDOL
orRIC
.- code
The actual identification code for this type.
TransactionalData Object¶
- created.byFirm.pmid
The Primary Market Identifier (PMID) of the underwriting entity that created the Deal.
- created.byFirm.lei
The Legal Entity Identifier of the firm that created the Deal.
- created.dateTime
The date and time of when the Deal was created.
Registration Object¶
- type
The type of registration. Valid values are
Exempt
,Private
orPublic
.- country
The country of registration.
- registrationRules
An array of rules that can be applied to the security registration. Valid values are
Rule144
,Rule144A
,Rule144AWithRegRights
,Rule3C7
,Rule415
,Rule424
,MJDS
,RegulationD
,RegulationS
,RegulationSBearer
,FormS1
,FormS2
,FormS3
,FormS11
,FormF1
,FormF2
,FormF3
,FormF6
,FormF8
,FormF9
,FormF10
,FormF80
,Form8A
,FormN2
,FormSB
,FormSB1
,FormSB2
,SecRegistered
,SecExempt
,Rule3A2Exempt
,AccreditedInvestors
,Global
,PrivatePlacement
,Domestic
,Eurobond
,Rule_4A2
,Rule_OneHalf
,Rule144ARegSWithRegRights
,Rule144ARegSWithoutRegRights
,Rule144AWithoutRegRights
,RegSWithRegRights
,RegSWithoutRegRights
,Rule144A3C7RegS
.
Settlement Object¶
- location
The settlement location (e.g. DTCC, Euroclear).
- currency
The settlement currency in ISO 4217 format.
- date
The date of settlement.
Redemption Option Object¶
- description
A description of the redemptionOption.
- type
The type of redemptionOption. Valid values are
Callable
,CallableAnytime
,MakeWholeCall
,NotCallableForLife
,Putable
,Convertible
,ChangeOfControl
,Sinkable
,Optional
, orPyramid
.- frequency
The payment frequency of the bond. Valid values are
Annual
,AnyDate
,InterestPaymentDue
orSemiAnnual
.- firstDate
The date of the bond’s first issuance.
- firstPrice
The price of the bond when it is first issued.
- lastDate
The date at which the last trade occured.
- lastPrice
The last price at which a bond is traded.
- maxPrice
The maximum price of the bond.
- priceIncrement
The price Increment at which the bond is quoted at.
- schedule
The schedule is a series of call dates on which the issuer can redeem the bond at specific prices. For full details see Schedule Object.
Schedule Object¶
- date
The call date.
- price
The call price.
Complex Amount Object¶
- Amount
The base amount of the complex amount type.
- Type
The type of the amount. Valid values are
Quantity
,Face
,Cash
.
Complex Amount With Percentage Object¶
- Amount
The base amount of the copmlex amount type.
- Type
The type of the amount. Valid values are
Quantity
,Face
,Percentage
,Cash
.
Complex Amount Text Object¶
- Amount
The amount in text form, such as “35000+” or “35k+”.
- Type
This would be null.
Complex Date Object¶
- date
The base date of the complex date type. This is used in conjunction with the qualifier to specify the date range for this object.
- qualifier
The qualifier to be applied to the base date to object the actual date range. Each possible value and it’s meaning is shown below:
Qualifier Value
Meaning
Date
The date is an exact date as shown
DatePre
The date is some indeterminate date before the base date
DatePost
The date is some indeterminate date after the base date
WeekOf
The date is the business week of the base date
WeekEarly
The date is early in the calendar week of the base date
WeekMid
The date is in the middle of the calendar week of the base date
WeekLate
The date is late in the calendar week of the base date
MonthEarly
The date is early in the calendar month of the base date
MonthMid
The date is in the middle of the calendar month of the base date
MonthLate
The date is late in the calendar month of the base date
Quarter
The date is in the same quarter of the year of the base date
ToBeDetermined
The date is yet to be determined
DayToDay
The date is not fully determined, but will be happening soon
Fee Object¶
Fees are not mandatory. If a fee is specified, both fee type and fee amount must be specified.
- type
The type of a fee. Can take following values:
GlobalCoordinator
,GrossSpread
,InternalSellingConcession
,SellingConcession
,IncentiveFee
,ManagementFee
,ManagersPraecipium
,Reallowance
,Underwriting
,Pot
.- amount
Complex object representing the amount of a fee. For more details, see Complex Amount Object.
Blue Sky Object¶
- countryCode
The Blue Sky Country Code. Valid values are
USA
orCAN
.- stateCode
The Blue Sky State Code. Valid values are:
AL
,AK
,AZ
,AR
,CA
,CO
,CT
,DE
,FL
,GA
,HI
,ID
,IL
,IN
,IA
,KS
,KY
,LA
,ME
,MD
,MA
,MI
,MN
,MS
,MO
,MT
,NE
,NV
,NH
,NJ
,NM
,NY
,NC
,ND
,OH
,OK
,OR
,PA
,RI
,SC
,SD
,TN
,TX
,UT
,VT
,VA
,WA
,WV
,WI
,WY
,DC
,AB
,BC
,MB
,NB
,NL
,NT
,NS
,NU
,ON
,PE
,QC
,SK
,YT
,AS
,GQ
,MH
,FM
,MP
,PW
,RQ
,VQ
- status
The Blue Sky Status. Valid values are
NotCleared
,Pending
,Withdrawn
,Cleared
.
Time Zone Names¶
AlphaTimeZone
,AustralianCentralDaylightTime
,AustralianCentralStandardTime
,AcreTime
,AustralianCentralTime
,AustralianCentralWesternStandardTime
,ArabiaDaylightTime
,AtlanticDaylightTime
,AustralianEasternDaylightTime
,AustralianEasternStandardTime
,AustralianEasternTime
,AfghanistanTime
,AlaskaDaylightTime
,AlaskaStandardTime
,AmazonSummerTime
,ArmeniaSummerTime
,AmazonTime
,ArmeniaTime
,AnadyrSummerTime
,AnadyrTime
,AqtobeTime
,ArgentinaTime
,ArabiaStandardTime
,AtlanticStandardTime
,AtlanticTime
,AustralianWesternDaylightTime
,AustralianWesternStandardTime
,AzoresSummerTime
,AzoresTime
,AzerbaijanSummerTime
,AzerbaijanTime
,AnywhereonEarth
,BravoTimeZone
,BruneiDarussalamTime
,BoliviaTime
,BrasiliaSummerTime
,BrasiliaTime
,BangladeshStandardTime
,BougainvilleStandardTime
,BritishSummerTime
,BhutanTime
,CharlieTimeZone
,CaseyTime
,CentralAfricaTime
,CocosIslandsTime
,CentralDaylightTime
,CubaDaylightTime
,CentralEuropeanSummerTime
,CentralEuropeanTime
,ChathamIslandDaylightTime
,ChathamIslandStandardTime
,ChoibalsanSummerTime
,ChoibalsanTime
,ChuukTime
,CaymanIslandsDaylightSavingTime
,CaymanIslandsStandardTime
,CookIslandTime
,ChileSummerTime
,ChileStandardTime
,ColombiaTime
,CentralStandardTime
,ChinaStandardTime
,CubaStandardTime
,CentralTime
,CapeVerdeTime
,ChristmasIslandTime
,ChamorroStandardTime
,DeltaTimeZone
,DavisTime
,DumontdUrvilleTime
,EchoTimeZone
,EasterIslandSummerTime
,EasterIslandStandardTime
,EasternAfricaTime
,EcuadorTime
,EasternDaylightTime
,EasternEuropeanSummerTime
,EasternEuropeanTime
,EasternGreenlandSummerTime
,EastGreenlandTime
,EasternStandardTime
,EasternTime
,FoxtrotTimeZone
,FurtherEasternEuropeanTime
,FijiSummerTime
,FijiTime
,FalklandIslandsSummerTime
,FalklandIslandTime
,FernandodeNoronhaTime
,GolfTimeZone
,GalapagosTime
,GambierTime
,GeorgiaStandardTime
,FrenchGuianaTime
,GilbertIslandTime
,GreenwichMeanTime
,GulfStandardTime
,SouthGeorgiaTime
,GuyanaTime
,HotelTimeZone
,HawaiiAleutianDaylightTime
,HongKongTime
,HovdSummerTime
,HovdTime
,HawaiiStandardTime
,IndiaTimeZone
,IndochinaTime
,IsraelDaylightTime
,IndianChagosTime
,IranDaylightTime
,IrkutskSummerTime
,IrkutskTime
,IranStandardTime
,IndiaStandardTime
,IrishStandardTime
,IsraelStandardTime
,JapanStandardTime
,KiloTimeZone
,KyrgyzstanTime
,KosraeTime
,KrasnoyarskSummerTime
,KrasnoyarskTime
,KoreaStandardTime
,KuybyshevTime
,LimaTimeZone
,LordHoweDaylightTime
,LordHoweStandardTime
,LineIslandsTime
,MikeTimeZone
,MagadanSummerTime
,MagadanTime
,MarquesasTime
,MawsonTime
,MountainDaylightTime
,MarshallIslandsTime
,MyanmarTime
,MoscowDaylightTime
,MoscowStandardTime
,MountainStandardTime
,MountainTime
,MauritiusTime
,MaldivesTime
,MalaysiaTime
,NovemberTimeZone
,NewCaledoniaTime
,NewfoundlandDaylightTime
,NorfolkDaylightTime
,NorfolkTime
,NovosibirskSummerTime
,NovosibirskTime
,NepalTime
,NauruTime
,NewfoundlandStandardTime
,NiueTime
,NewZealandDaylightTime
,NewZealandStandardTime
,OscarTimeZone
,OmskSummerTime
,OmskStandardTime
,OralTime
,PapaTimeZone
,PacificDaylightTime
,PeruTime
,KamchatkaSummerTime
,KamchatkaTime
,PapuaNewGuineaTime
,PhoenixIslandTime
,PhilippineTime
,PakistanStandardTime
,PierreAndMiquelonDaylightTime
,PierreAndMiquelonStandardTime
,PohnpeiStandardTime
,PacificStandardTime
,PitcairnStandardTime
,PacificTime
,PalauTime
,ParaguaySummerTime
,ParaguayTime
,PyongyangTime
,QuebecTimeZone
,QyzylordaTime
,RomeoTimeZone
,ReunionTime
,RotheraTime
,SierraTimeZone
,SakhalinTime
,SamaraTime
,SouthAfricaStandardTime
,SolomonIslandsTime
,SeychellesTime
,SingaporeTime
,SrednekolymskTime
,SurinameTime
,SamoaStandardTime
,SyowaTime
,TangoTimeZone
,TahitiTime
,FrenchSouthernandAntarcticTime
,TajikistanTime
,TokelauTime
,EastTimorTime
,TurkmenistanTime
,TongaSummerTime
,TongaTime
,TurkeyTime
,TuvaluTime
,UniformTimeZone
,UlaanbaatarSummerTime
,UlaanbaatarTime
,CoordinatedUniversalTime
,UruguaySummerTime
,UruguayTime
,UzbekistanTime
,VictorTimeZone
,VenezuelanStandardTime
,VladivostokSummerTime
,VladivostokTime
,VostokTime
,VanuatuTime
,WhiskeyTimeZone
,WakeTime
,WesternArgentineSummerTime
,WestAfricaSummerTime
,WestAfricaTime
,WesternEuropeanSummerTime
,WesternEuropeanTime
,WallisandFutunaTime
,WesternGreenlandSummerTime
,WestGreenlandTime
,WesternIndonesianTime
,EasternIndonesianTime
,CentralIndonesianTime
,WestSamoaTime
,WesternSaharaSummerTime
,WesternSaharaStandardTime
,XrayTimeZone
,YankeeTimeZone
,YakutskSummerTime
,YakutskTime
,YapTime
,YekaterinburgSummerTime
,YekaterinburgTime
orZuluTimeZone
.
FX Rates Object¶
- filing
The corresponding fx rates that are set at filing for the deal.This is an array.For full details see FX Rate Object.
- offering
The corresponding fx rates that are set at offering for the deal.This is an array.For full details see FX Rate Object.
- settlement
The corresponding fx rates that are set at settlement for the deal.This is an array.For full details see FX Rate Object.
FX Rate Object¶
- baseCurrencyCode
The base currency code of the deal.For list of currencies refer Currency Code Enum.
- currencyCode
The currency code of the deal.For list of currencies refer Currency Code Enum.
- rate
The rate of the deal.
Currency Code Enum¶
AFG
,EUR
,ALL
,DZD
,USD
,AOA
,XCD
,ARS
,AMD
,AWG
,AUD
,AZN
,BSD
,BHD
,BDT
,BBD
,BYN
,BZD
,XOF
,BMD
,INR
,BTN
,BOB
,BOV
,BAM
,BWP
,NOK
,BRL
,BND
,BGN
,BIF
,CVE
,KHR
,XAF
,CAD
,KYD
,CLP
,CLF
,CNY
,COP
,COU
,KMF
,CDF
,NZD
,CRC
,HRK
,CUP
,CUC
,ANG
,CZK
,DKK
,DJF
,DOP
,EGP
,SVC
,ERN
,ETB
,FKP
,FJD
,XPF
,GMD
,GEL
,GHS
,GIP
,GTQ
,GBP
,GNF
,GYD
,HTG
,HNL
,HKD
,HUF
,ISK
,IDR
,XDR
,IRR
,IQD
,ILS
,JMD
,JPY
,JOD
,KZT
,KES
,KPW
,KRW
,KWD
,KGS
,LAK
,LBP
,LSL
,ZAR
,LRD
,LYD
,CHF
,MOP
,MKD
,MGA
,MWK
,MYR
,MVR
,MRU
,MUR
,XUA
,MXN
,MXV
,MDL
,MNT
,MAD
,MZN
,MMK
,NAD
,NPR
,NIO
,NGN
,OMR
,PKR
,PAB
,PGK
,PYG
,PEN
,PHP
,PLN
,QAR
,RON
,RUB
,RWF
,SHP
,WST
,STN
,SAR
,RSD
,SCR
,SLL
,SGD
,XSU
,SBD
,SOS
,SSP
,LKR
,SDG
,SRD
,SZL
,SEK
,CHE
,CHW
,SYP
,TWD
,TJS
,TZS
,THB
,TOP
,TTD
,TND
,TRY
,TMT
,UGX
,UAH
,AED
,USN
,UYU
,UYI
,UYW
,UZS
,VUV
,VES
,VND
,YER
,ZMW
,ZWL
Industry Classification Object¶
- industryGroup
This is an enum and has the values
Energy
,Materials
,CapitalGoods
,CommercialandProfessionalServices
,Transportation
,AutomobilesandComponents
,ConsumerDurablesandApparel
,ConsumerServices
,Retailing
,ConsumerGoods
,FoodandStaplesRetailing
,FoodBeverageandTobacco
,HouseholdandPersonalProducts
,HealthCareEquipmentandServices
,PharmaceuticalsBiotechnologyandLifeSciences
,Banks
,DiversifiedFinancials
,Insurance
,SoftwareandServices
,TechnologyHardwareandEquipment
,SemiconductorsandSemiconductorEquipment
,CommunicationServices
,MediaandEntertainment
,Utilities
,RealEstate
- industry
This is an enum and has the values
RenewableEnergyEquipmentandServices
,EnergyEquipmentandServices
,OilGasandConsumableFuels
,Chemicals
,ConstructionMaterials
,ContainersandPackaging
,MetalsandMining
,PaperandForestProducts
,AerospaceandDefense
,MaterialsandConstruction
,BuildingProducts
,ConstructionandEngineering
,ElectricalEquipment
,IndustrialConglomerates
,Machinery
,TradingCompaniesandDistributors
,CommercialServicesandSupplies
,ProfessionalServices
,AirFreightandLogistics
,Airlines
,Marine
,RoadandRail
,TransportationInfrastructure
,GeneralIndustrials
,AutoComponents
,Automobiles
,HouseholdDurables
,LeisureProducts
,TextilesApparelandLuxuryGoods
,HotelsRestaurantsandLeisure
,TravelServicesandLeisure
,DiversifiedConsumerServices
,Wholesale
,Homebuilding
,Media
,PersonalServices
,Distributors
,InternetandDirectMarketingRetail
,MultilineRetail
,SpecialtyRetail
,ConsumerDurables
,FoodandStaplesRetailing
,Beverages
,FoodProducts
,Tobacco
,HouseholdProducts
,PersonalProducts
,HealthCareEquipmentandSupplies
,HealthCareProvidersandServices
,HealthCareTechnology
,Biotechnology
,Pharmaceuticals
,LifeSciencesToolsandServices
,Banks
,ThriftsandMortgageFinance
,DiversifiedFinancialServices
,ConsumerFinance
,CapitalMarkets
,MortgageRealEstateInvestmentTrusts
,Insurance
,ITServices
,Software
,CommunicationsEquipment
,TechnologyHardwareStorageandPeripherals
,ElectronicEquipmentInstrumentsandComponents
,SemiconductorsandSemiconductorEquipment
,DiversifiedTelecommunicationServices
,WirelessTelecommunicationServices
,Entertainment
,InteractiveMediaandServices
,ElectricUtilities
,GasUtilities
,MultiUtilities
,WaterUtilities
,IndependentPowerandRenewableElectricityProducers
,EquityRealEstateInvestmentTrusts
,RealEstateManagementandDevelopment
- subIndustry
This is an enum and has the values
RenewableEnergyEquipmentandServices
,OilandGasDrilling
,OilandGasEquipmentandServices
,IntegratedOilandGas
,OilandGasExplorationandProduction
,OilandGasRefiningandMarketing
,OilandGasStorageandTransportation
,CoalandConsumableFuels
,CommodityChemicals
,DiversifiedChemicals
,FertilizersandAgriculturalChemicals
,IndustrialGases
,SpecialtyChemicals
,MetalandGlassContainers
,ConstructionMaterials
,PaperPackaging
,Aluminum
,DiversifiedMetalsandMining
,Copper
,Gold
,PreciousMetalsandMinerals
,Silver
,Steel
,PreviousStones
,ForestProducts
,PaperProducts
,AerospaceandDefense
,BuildingProducts
,ConstructionandEngineering
,WasteManagement
,ElectricalComponentsandEquipment
,HeavyElectricalEquipment
,IndustrialConglomerates
,ConstructionMachineryandHeavyTrucks
,AgriculturalandFarmMachinery
,IndustrialMachinery
,TradingCompaniesandDistributors
,CommercialPrinting
,EnvironmentalandFacilitiesServices
,OfficeServicesandSupplies
,DiversifiedSupportServices
,SecurityandAlarmServices
,HumanResourceandEmploymentServices
,PollutionControlEquipment
,ResearchandConsultingServices
,AirFreightandLogistics
,Airlines
,Marine
,Railroads
,Trucking
,AirportServices
,HighwaysandRailtracks
,MarinePortsandServices
,AutoPartsandEquipment
,CommercialVehiclesandTrucks
,DeliveryServices
,TiresandRubber
,OtherIndustrialGoods
,AutomobileManufacturers
,MotorcycleManufacturers
,ConsumerElectronics
,HomeFurnishings
,Homebuilding
,HouseholdAppliances
,HousewaresandSpecialties
,LeisureProducts
,Apparel
,AccessoriesandLuxuryGoods
,Footwear
,Textiles
,CasinosandGaming
,Hotels
,ResortsandCruiseLines
,LeisureFacilities
,Restaurants
,EducationServices
,SpecializedConsumerServices
,SportingActivities
,TravelandTourism
,Distributors
,InternetandDirectMarketingRetail
,Wholesale
,ResidentialConstruction
,FilmProductionandTheaters
,RadioBroadcasting
,TelevisionBroadcasting
,RentalandLeasingServices
,DepartmentStores
,GeneralMerchandiseStores
,ApparelRetail
,ComputerandElectronicsRetail
,HomeImprovementRetail
,SpecialtyStores
,AutomotiveRetail
,HomefurnishingRetail
,DrugRetail
,FoodDistributors
,JewelryRetail
,SportingGoods
,ToysandGames
,PhotographicEquipmentandSupplies
,FoodRetail
,HypermarketsandSuperCenters
,Brewers
,DistillersandVintners
,SoftDrinks
,AgriculturalProducts
,PackagedFoodsandMeats
,Tobacco
,HouseholdProducts
,PersonalProducts
,HealthCareEquipment
,HealthCareSupplies
,HealthCareDistributors
,HealthCareServices
,HealthCareFacilities
,HospitalsandOtherHealthcareFacilitiesandServices
,ManagedHealthCare
,HealthCareTechnology
,Biotechnology
,Pharmaceuticals
,LifeSciencesToolsandServices
,DiversifiedBanks
,RegionalBanks
,ThriftsandMortgageFinance
,OtherDiversifiedFinancialServices
,MultiSectorHoldings
,SpecializedFinance
,ConsumerFinance
,AssetManagementandCustodyBanks
,InvestmentBankingandBrokerage
,DiversifiedCapitalMarkets
,FinancialExchangesandData
,MortgageREITs
,InsuranceBrokers
,LifeandHealthInsurance
,MultilineInsurance
,SuretyandTitleinsurance
,PropertyandCasualtyInsurance
,Reinsurance
,ITConsultingandOtherServices
,DataProcessingandOutsourcedServices
,InternetServicesandInfrastructure
,ApplicationSoftware
,SystemsSoftware
,CommunicationsEquipment
,DiversifiedSoftwareandServices
,EntertainmentSoftwareandHardware
,TechnologyHardware
,StorageandPeripherals
,ElectronicEquipmentandInstruments
,ComputersandComputerBasedSystems
,ElectronicComponents
,ElectronicManufacturingServices
,TechnologyDistributors
,SemiconductorEquipment
,Semiconductors
,AlternativeCarriers
,IntegratedTelecommunicationServices
,WirelessTelecommunicationServices
,Advertising
,Broadcasting
,CableandSatellite
,Publishing
,MoviesandEntertainment
,InteractiveHomeEntertainment
,InteractiveMediaandServices
,ElectricUtilities
,GasUtilities
,MultiUtilities
,WaterUtilities
,IndependentPowerProducersandEnergyTraders
,RenewableElectricity
,DiversifiedREITs
,IndustrialREITs
,HotelandResortREITs
,OfficeREITs
,HealthCareREITs
,ResidentialREITs
,RetailREITs
,SpecializedREITs
,RealEstateInvestmentTrusts
,DiversifiedRealEstateActivities
,RealEstateOperatingCompanies
,RealEstateDevelopment
,RealEstateServices
Comments¶
Comments are not mandatory, they can be null or an empty array. However, if a comment is specified it must have both type and text. Several comments of the same type can be present in the array.
The type of the comment. Valid enum values can be
General
,Proceeds
,TargetMarket
,Fees
orRestrictions
.The text of the comment.