Indications¶

The Indication service provides functionality to create, amend and view Indications, as well as Hedges, across the full set of supported asset classes.

Base Urls¶

The Indication services base Urls are as follows:

Service Root	/book-building/indications
Health Check	/book-building/indications/hc/status
Swagger/Open API	/book-building/indications/docs/index.html

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.

Indication:

Name	Method	Url	Description
Search Indication	Search	/v5/indications/search	Search Indications using specified search criteria
Get Indication	Get	/v5/indications/{id}	Get a specific Indication by ID
Create Indication	Post	/v5/indications	Creates a new Indication
Delete Indication by Source Id	Delete	/v5/indications	Delete an Indication by Source Id
Delete Indication by ID	Delete	/v5/indications/{id}	Delete an Indication by ID
Update Indication	Put	/v5/indications	Update a specific Indication
Update Indication Attribute(s)	Patch	/v5/indications/{id}	Update a specific attribute of an Indication by ID

Indication Group:

Name	Method	Url	Description
Search Indication Group	Search	/v1/indication-groups/search	Search Indication Groups using specified search criteria
Get Indication Group by ID	Get	/v1/indication-groups/{id}	Get a specific Indication Group by ID
Get Indication Group by Source ID	Get	/v1/indication-groups	Get a specific Indication Group by SourceId
Create Indication Group	Post	/v1/indication-groups	Create an Indication Group
Delete Indication Group by ID	Delete	/v1/indication-groups/{id}	Delete an Indication Group by ID
Delete Indication Group by Source ID	Delete	/v1/indication-groups	Delete an Indication Group by Source ID
Update Indication Group	Put	/v1/indication-groups	Update a specific Indication Group
Update Indication Group Attribute(s)	Patch	/v1/indication-groups	Update a specific attribute of an Indication by ID

Hedge:

Name	Method	Url	Description
Search Hedge	Search	/v5/hedges/search	Search for Hedges using specified search criteria
Get Hedge by ID	Get	/v5/hedges/{id}	Get a specific Hedge by ID
Create Hedge	Post	/v5/hedges	Creates a new Hedge
Delete Hedge by ID	Delete	/v5/hedges/{id}	Delete a Hedge by ID
Delete Hedge by Source ID	Delete	/v5/hedges	Delete a Hedge by Source ID
Update Hedge	Put	/v5/hedges	Update a specific Hedge
Update Hedge Attribute(s)	Patch	/v5/hedges/{id}	Update a specific attribute of a Hedge by ID

Search Criteria

The search criteria for Orders services is displayed below.

{
        "criteria": [{
                        "field": "string",
                        "operator": "=",
                        "value": "string"
                }
        ]
}

Indication¶

The Indication resource allows a user to create Indications of Interest (IOI). IOI’s are used to express non-binding interest in buying an asset currently in registration.

Search Indication¶

The search Indications endpoint provides a way of accessing a collection of Indication objects based on the search fields.

Authorization

In order to access the Indications information, it is required to have the indications-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
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Indication Objects. The pagination is in the standard CAS format as described in Pagination.

Get Indication¶

The get Indication endpoint provides a way of accessing a specific Indication object by id.

Authorization

In order to access the Indications information, it is required to have the indications-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 Indication to retrieve

Response

The endpoint returns a JSON payload containing an Indication Object.

Create Indication¶

The Create Indication endpoint provides a way of creating an Indication object in the CAS system.

Authorization

In order to access the Indications information, it is required to have the indications-write scope in the access token.

Parameters

This endpoint accepts an Indication object as its body, which can be found in the schema section.

Response

The endpoint returns a JSON payload containing the newly created Indication Object.

Delete Indication by ID¶

The Delete Indication endpoint provides a way of deleting an Indication object in the CAS system.

Authorization

In order to delete the Indication, it is required to have the indications-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the Indication to retrieve

Response

The endpoint returns a 200 OK response when the item is properly deleted.

Delete Indication by Source ID¶

The Delete Indication endpoint provides a way of deleting an Indication object in the CAS system.

Authorization

In order to delete the Indication, it is required to have the indications-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique Source id of the Indication to retrieve

Response

The endpoint returns a 200 OK response when the item is properly deleted.

Update Indication¶

The Update Indication endpoint provides a way of updating a specific Indication object.

Authorization

In order to access the Indications information, it is required to have the indications-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a current Indication object in the request body which needs updating.

Note: If trying to update investorAccount.name, investorAccountId must be null.

Response

The endpoint returns a JSON payload containing the new, updated Indication Object.

Update Indication Attribute(s)¶

This Update Indication endpoint provides a way of updating specific fields of an existing Indication object.

Authorization

In order to access the Indications information, it is required to have the indications-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a list of fields for the Indication object to be updated.

[
    {
        "value": {},
        "path": "string",
        "op": "string",
        "from": "string"
    }
]

Response

The endpoint returns a JSON payload containing the new, updated Indication Object.

Indication Group¶

Search Indication Group¶

The search Indication Groups endpoint provides a way of accessing a collection of Indication Group objects based on the search fields.

Authorization

In order to access the Indication Groups information, it is required to have the indication-groups-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
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Indication Group Objects. The pagination is in the standard CAS format as described in Pagination.

Get Indication Group by ID¶

The get Indication Group endpoint provides a way of accessing a specific Indication Group object by ID.

Authorization

In order to access the Indications information, it is required to have the indication-groups-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 Indication Group to retrieve

Response

The endpoint returns a JSON response containing an Indication Object.

Get Indication Group by Source ID¶

This get Indication Group endpoint provides a way of retrieving a specific Indication Group 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 access the Indications information, it is required to have the indication-groups-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
sourceID	UUID	Querystring	The unique Source id of the Indication Group to retrieve

Response

The endpoint returns a JSON response containing an Indication Group Object.

Create Indication Group¶

The Create Indication Group endpoint provides a way of creating an Indication Group object in the CAS system.

Authorization

In order to access the Indication Groups information, it is required to have the indication-groups-write scope in the access token.

Parameters

This endpoint accepts an Indication Group object as its body.

Response

The endpoint returns a JSON payload containing the newly created Indication Group Object.

Delete Indication Group by ID¶

The Delete Indication Group endpoint provides a way of deleting an Indication Group object in the CAS system.

Authorization

In order to access the Indication Group information, it is required to have the indication-groups-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Indication Group to delete.

Delete Indication Group by Source ID¶

This delete Indication Group endpoint provides a way of deleting a specific Indication Group 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 access the Indication Group information, it is required to have the indication-groups-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique Source id of the Indication Group to delete.

Response

The endpoint returns a 200 OK response when the item is properly deleted.

Update Indication Group¶

The Update Indication Group endpoint provides a way of updating a specific Indication Group object.

Authorization

In order to access the Indication Groups information, it is required to have the indication-groups-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a JSON payload of an Indication Group object, excluding createdBy and createdDateTime information.

Response

The endpoint returns a JSON payload containing the new, updated Indication Group Object.

Update Indication Group Attribute(s)¶

This Update Indication Group endpoint provides a way of updating specific fields of an existing Indication group object.

Authorization

In order to access the Indications information, it is required to have the indication-groups-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a list of fields for the Indication group object to be updated.

[
    {
        "value": {},
        "path": "string",
        "op": "string",
        "from": "string"
    }
]

Response

The endpoint returns a JSON payload containing the new, updated Indication Group Response Object.

Hedge¶

Search Hedge¶

The search Hedge endpoint provides a way of accessing a collection of Hedge objects based on the search fields.

Authorization

In order to access the Hedge information, it is required to have the hedges-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
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Hedge Objects.

Get Hedge by ID¶

The get Hedge endpoint provides a way of accessing a specific Hedge object by id.

Authorization

In order to access the Hedges information, it is required to have the hedges-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 hedge to retrieve

Response

The endpoint returns a JSON payload containing the Hedge Object.

Create Hedge¶

The Create Hedge endpoint provides a way of creating an Hedge object in the CAS system.

Authorization

In order to create the Hedges, it is required to have the hedges-write scope in the access token.

Parameters

This endpoint accepts an Hedge object as its body, as described in the schema.

Response

The endpoint returns a JSON payload containing the newly created Hedge object.

Delete Hedge by ID¶

The Delete Hedge endpoint provides a way of deleting an Hedge object in the CAS system.

Authorization

In order to access the Hedges information, it is required to have the hedges-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the hedge to delete.

Response

The endpoint returns a 200 OK response when the item is properly deleted.

Delete Hedge by Source ID¶

The Delete Hedge endpoint provides a way of deleting an Hedge object in the CAS system.

Authorization

In order to access the Hedges information, it is required to have the hedges-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique Source id of the hedge to delete.

Response

The endpoint returns a 200 OK response when the item is properly deleted.

Update Hedge¶

The Update Hedge endpoint provides a way of updating a specific Hedge object.

Authorization

In order to access the Hedges information, it is required to have the hedges-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Hedge object to be updated.

Response

The endpoint returns a JSON payload containing the new, updated Hedge object.

Update Hedge Attribute(s)¶

This Update Hedge endpoint provides a way of updating a specific attribute of a Hedge object using the CAS Id of the record.

Authorization

In order to modify the Hedges information, it is required to have the hedges-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a list of fields for the Hedge object to be updated.

Example JSON

[
    {
        "value": {},
        "path": "string",
        "op": "string",
        "from": "string"
    }
]

Response

The endpoint returns a JSON payload containing the new, updated Hedge object.

Schema¶

The Indication, Hedge, and Indication Group object structures are shown below, and underneath each JSON example, every element is described in detail.

Indication Schema¶

Example JSON

{
  "createdBy": "string",
  "createdDateTime": "2020-04-17T03:10:15.849Z",
  "lastModifiedBy": "string",
  "lastModifiedDateTime": "2020-04-17T03:10:15.849Z",
  "detail": {
        "order": {
          "attestation": {
                "isAttested": true,
                "createdBy": "string",
                "createdDateTime": "2020-04-17T03:10:15.849Z"
          },
          "isWholeTrancheOrder": true,
          "investorAccountContactId": "string",
          "isProspectusSent": true,
          "isInvestorAccess": true,
          "commitmentType": "soft",
          "retentionType": "pot",
          "investorAccountContactData":[
                        {
                                "description":"string",
                                "firstName":"test",
                                "lastName":"test1",
                                "email":"email1",
                                "role":0
                        },
                        {
                                "id":"39fa3c66-15f2-00f4-72a9-6204a937a354",
                                "role":1
                        }
          ],
          "managers": [
          {
                "pmid": "string",
                "lei" : "string",
                "orionId" : "string",
                "communicationMode": "electronic",
                "percentageBreakdown": 1
          }
          ],
          "leiIds": [
                "string"
          ],
          "clientLeiIds": [
                "string"
          ],
          "investorAccountContactIds": [
                "string"
          ],
          "salesCredit": {
                "subsidiary": "string",
                "region": "string",
                "salesPersonExternalId": "string"
          },
          "billDeliveryData": {
                "brokerPmid": "string",
                "brokerName": "string",
                "brokerCode": "string"
          },
          "demandType": "distribution"
        },
        "investor": {
          "isDataHidden": true,
          "alias": "string"
        },
        "deliveryInstructions": {
          "registrations": [
                {
                  "rule": "rule144",
                  "value": {
                        "type": "cash",
                        "data": {
                          "amount": 0
                        }
                  }
                }
          ],
          "settlementCurrency": "USD"
        }
  },
  "investorAccount": {
        "name": "string",
        "identifications": [
          {
                "id": "string",
                "name": "string",
                "source": "lei"
          }
        ],
        "category": "agency",
        "country": "afg",
        "sourceId": "string",
        "orionId": "string"
  },
  "dealId": "string",
  "trancheId": "string",
  "companyId": 0,
  "investorAccountId": "string",
  "sourceId": "string",
  "salesPersonId": "string",
  "salesPersonData": {
        "id": "string",
        "externalId": "string"
  },
  "userGroupId": "string",
  "traderGroupId": "string",
  "sourceRowVersion": "string",
  "orderStatus": "pending",
  "steps": [
        {
          "deliveryType": "distribution",
          "limit": {
                "type": "spread",
                "data": {
                  "level": 0
                }
          },
          "value": {
                "type": "cash",
                "data": {
                  "amount": 0
                }
          },
          "limits": [
                {
                  "type": "spread",
                  "data": {
                        "level": 0
                  }
                }
          ]
        }
  ],
  "indicationGroupId": "string",
  "ownerPmid": "string",
  "statusMessages": [
        {
          "code": "string",
          "message": "string"
        }
  ],
  "approvedOrder": {
        "detail": {
                "order": {
                        "attestation": {
                        "isAttested": true,
                        "createdBy": "string",
                        "createdDateTime": "2021-03-30T05:37:18.141Z"
                        },
                        "commitmentType": "soft",
                        "retentionType": "pot",
                        "allocationCounterparty": "string",
                        "investorAccountContactData": [
                        {
                        "description": "string",
                        "firstName": "string",
                        "middleName": "string",
                        "lastName": "string",
                        "email": "string",
                        "role": "operationsCompliance",
                        "id": "string",
                        "sourceId": "string"
                        }
                        ]
                        },
         "deliveryInstructions": {
      "registrations": [
        {
          "rule": "rule144",
          "value": {
            "type": "cash",
            "data": {
              "amount": 0
            }
          }
        }
      ],
      "settlementCurrency": "afg"
    }
  },
"steps": [
    {
                  "deliveryType": "distribution",
      "productId": "string",
      "limitProductId": "string",
      "value": {
        "type": "cash",
        "data": {
          "amount": 0,
          "currencyCode": "afg"
        }
      },
      "limits": [
        {
          "type": "spread",
          "data": {
            "level": 0,
            "currencyCode": "afg",
            "reference": {
              "style": "benchmark",
              "type": "security",
              "name": "string",
              "identificationType": "symbol",
              "identificationCode": "string"
            }
          }
        }
      ]
    }
  ],
"entryFormat": "additive",
"isCancelled": true,
"lastModifiedBy": "string",
"lastModifiedDateTime": "2021-03-30T10:59:35.491Z"
},
  "comment": {
        "cancellationComment": {
          "cancellationReason": "string",
          "comment": "string"
        },
        "additionalComments": [
          {
                "commentType": "public",
                "comment": "string",
                "lastModifiedBy": "string",
                "lastModifiedDateTime": "2020-04-17T03:10:15.849Z"
          }
        ]
  },
  "entryFormat": "additive",
  "isCancelled": true
}

Indication Object

createdBy

Represents user Id who creates this indication.

createdDateTime

Created datetime for this indication.

lastModifiedBy

Represents user Id who last modified this indication.

lastModifiedDateTime

Last modified datetime for this indication.

detail.order.attestation.isAttested

Boolean representing whether the Indication is attested or not.

detail.order.investorAccountContactId

ID of the Investor Account Contact for this Indication.

detail.order.isProspectusSent

Boolean representing whether the prospectus was sent for this Indication.

detail.order.isInvestorAccess

Boolean representing whether IA is involved in this Indication.

detail.order.commitmentType

Represents the commitment type of the indication. Valid values are soft or firm

detail.order.retentionType

Represents the retention type of the indication. Valid values are pot or retention

detail.order.investorAccountContactData.id

Id of the Investor Contact associated with the Order

detail.order.investorAccountContactData.firstName

First Name of the Investor Contact associated with the Order

detail.order.investorAccountContactData.lastName

Last Name of the Investor Contact associated with the Order

detail.order.investorAccountContactData.email

Email address of the Investor Contact associated with the Order

detail.order.investorAccountContactData.role

The Role of the Investor Contact associated with the Order. Valid values are operationsCompliance, or orderPlacer, or portfolioManager

detail.order.investorAccountContactData.description

Describes contact that is not an individual with First and Last name but rather an entity or group such as a team or desk.

detail.order.managers.pmid

PMID of the manager assigned to this Indication.

detail.order.managers.lei

The Legal Entity Identifier (LEI) of the manager assigned to this Indication. Field is optional.

detail.order.managers.orionId

Represents the Orion Id of the manager.

detail.order.managers.communicationMode

Represents the order managers communication mode. Valid values are electronic or manual

detail.order.managers.percentageBreakdown

Represents the breakdown of the Indication among Syndicate banks where the total must equal 1. Percentage is dictated in decimal format where .20 equals 20% and 1 equals 100%. Field is optional.

detail.order.leiIds

Represents the legal entity ID’s for this record.

detail.order.clientLeiIds

Represents the client legal entity ID’s for this record.

detail.order.investorAccountContactIds

Represents the Investor Account Contact ID’s for this record.

detail.order.salesCredit.subsidiary

Represents the subsidiary of the sales credit.

detail.order.salesCredit.region

Represents the region of the sales credit.

detail.order.salesPersonExternalId

Represents the sales person external ID.

detail.order.isWholeTrancheOrder

This indicates if the order is a whole tranche order on a deal.

detail.order.billDeliveryData.brokerPmid

Represents the PMID of the broker.

detail.order.billDeliveryData.brokerName

Represents the name of the broker.

detail.order.billDeliveryData.brokerCode

Represents the code of the broker.

detail.order.demandType

Represents the bond type on the order. Valid values are distribution or underwriting

detail.investor.isDataHidden

Boolean indicating whether the investor information is hidden.

detail.investor.alias

Represents the alias of the investor.

detail.deliveryInstructions.registrations.rule

Contains the rule type for the delivery instructions.

detail.deliveryInstructions.registrations.value.type

Represents the type of value for the Indication. Valid values are cash, percentage, face, or quantity.

detail.deliveryInstructions.registrations.value.data.amount

Represents the amount of the specified indication.

detail.deliveryInstructions.settlementCurrency

The currency at which the Investor will want to settle any allocation.

dealId

Represents the id of the deal this indication belongs to.

trancheId

Represents the id of the tranche this indication belongs to.

companyId

Company id representing who placed the indication.

investorAccountId

Represents the investor Account id this indication is tied to.

investorAccount.name

Optional value to declare a OneOff Indication, if this value is used, investorAccountId must be null.

investorAccount.identifications.id

Represents the Id of the identification used.

investorAccount.identifications.name

Represents the Name of the identification used.

investorAccount.identifications.source

Represents the source of the identification used. Valid values are lei or clientLei.

investorAccount.category

Represents the category of the investor account. Valid values are agency or assetManagement or bank or bankTreasury or centralBank or corporate or foundationCharity or fundManager or hedgeFund or highNetWorth or insuranceCompany or moneyMarketFund or municipal or pensionFund or privateBank or retail or securities or sovereign or supernational

investorAccount.country

The country of the Investor Account in ISO 3166-1 alpha-3 format.

investorAccount.sourceId

Represents the source application Id of the investor.

investorAccount.orionId

Represents the orion Id of the investor.

sourceId

Id of this indication in the source application, if it exists.

salesPersonId

Represents the id of the sales person this order is tied to.

salesPersonData.id

Represents the id of the sales person this order is tied to.

salesPersonData.externalId

Represents the external id of the sales person this order is tied to.

userGroupId

Represents the id of the user group this order belongs to

traderGroupId

The Sales Trader Group selected by the Sales user during order entry that affects the commission breakdown of the sales credits.

sourceRowVersion

Used for concurrency check in the source system, if applicable.

orderStatus

Represents the status of the order. Valid values are pending, delivered, successful, failed or deletePending.

steps.deliveryType

Indicates when a firm will pay for and collect bonds on a distribution order. Valid values are distribution or listing.

steps.limit.type

Represents the type of the limit order. Valid values are spread, yield, price, others, discount, coupon, premium, minTranche or maxTranche.

steps.limit.data.level

Represents the level of the order.

steps.value.type

Represents the type of the order. Valid values are cash, percentage, face or quantity.

steps.value.amount

Represents the amount of the order.

steps.limits.type

Represents the type of the limit order. Valid values are spread, yield, price, others, discount, coupon, premium, minTranche or maxTranche.

steps.limits.data.level

Represents the level of the order.

indicationGroupId

Represents the id of the IndicationGroup this Indication belongs to

ownerPmid

Represents the PMID of the owner for this indication.

statusMessages

code: Represents the code of the status message.
message: Contains the message of this status message.

approvedOrder.detail.order.attestation.isAttested

Boolean representing whether the Indication is attested or not.

approvedOrder.detail.order.attestation.createdBy

Represents the ID of the user who submitted the attestation for the Approved Order.

approvedOrder.detail.order.attestation.createdDateTime

Represents the date and time for the attestation of the Approved Order.

approvedOrder.detail.order.commitmentType

Represents the commitment type of the Approved Order. Valid values are soft or firm.

approvedOrder.detail.order.retentionType

Represents the retention type of the Approved Order. Valid values are pot or retention.

approvedOrder.detail.order.allocationCounterparty

Represents the counterparty for the allocation.

approvedOrder.detail.deliveryInstructions.registrations.rule

Contains the rule type for the delivery instructions.

approvedOrder.detail.deliveryInstructions.registrations.value.type

Represents the type of value for the Approved Order. Valid values are cash, percentage, face or quantity.

approvedOrder.detail.deliveryInstructions.registrations.value.data.amount

Represents the amount of the specified Indication.

approvedOrder.detail.deliveryInstructions.settlementCurrency

The currency at which the Investor will want to settle any allocation.

approvedOrder.steps.deliveryType

Indicates when a firm will pay for and collect bonds on a distribution order. Valid values are distribution or listing.

approvedOrder.steps.productId

Represents the product ID of the order.

approvedOrder.steps.limitProductId

Represents the product ID of the limit order.

approvedOrder.steps.value.type

Represents the type of the order. Valid values are cash, percentage, face or quantity.

approvedOrder.steps.value.data.amount

Represents the amount of the order.

approvedOrder.steps.value.data.currencyCode

Represents the currency code of the order. For list of currencies refer to the Currency Code Enum List. Note: Insert currency code enum list like we have in the Deals client facing documentation.

approvedOrder.steps.limits.type

Represents the type of the limit order. Valid values are spread, yield, price, others, discount, coupon, premium, minTranche or maxTranche.

approvedOrder.steps.limits.data.level

Represents the level of the limit order.

approvedOrder.steps.limits.data.currencyCode

Represents the currency code of the limit order. For list of currencies refer to the Currency Code Enum List. Note: Insert currency code enum list like we have in the Deals client facing documentation.

approvedOrder.steps.limits.data.reference.style

Represents the order reference style. Valid values are benchmark or pricing.

approvedOrder.steps.limits.data.reference.type

Represents the order reference type. Valid values are security , floatingRateIndex , midSwaps , assetSwaps or interpolation.

approvedOrder.steps.limits.data.reference.name

Represents the order reference name.

approvedOrder.steps.limits.data.reference.identificationType

Represents the identification type of the order. Valid values are symbol , cusip , isin , sedol , ric or common.

approvedOrder.steps.limits.data.reference.identificationCode

Represents the order identification code.

approvedOrder.entryFormat

Represents the format of the entry being recorded. Valid values are additive or cumulative.

approvedOrder.isCancelled

Indicates if the order is cancelled or not.

approvedOrder.lastModifiedBy

The user ID of the user who last modified the Approved Order.

approvedOrder.lastModifiedDateTime

The timestamp of when the Approved Order was last modified.

approvedOrder.investorAccountContactData.description

Describes contact that is not an individual with First and Last name but rather an entity or group such as a team or desk.

approvedOrder.investorAccountContactData.firstName

The first name of the Investor Contact associated with the Order.

approvedOrder.investorAccountContactData.middleName

The middle name of the Investor Contact associated with the Order.

approvedOrder.investorAccountContactData.lastName

The last name of the Investor Contact associated with the Order.

approvedOrder.investorAccountContactData.email

The email address of the Investor Contact associated with the Order.

approvedOrder.investorAccountContactData.role

The Role of the Investor Contact associated with the Order. Valid values are OperationsCompliance , OrderPlacer , PortfolioManager or CriticalContact.

approvedOrder.investorAccountContactData.id

The ID of the Investor Contact associated with the Order

approvedOrder.investorAccountContactData.sourceId

The source application ID of the Investor Contact with the Order.

comment.cancellationComment.cancellationReason

Represents the reason for cancelling the order.

comment.cancellationComment.comment

Represents the comment of the cancellation.

comment.additionalComments.commentType

Represents the type of additional comment posted. Valid values are public, private or sales.

comment.additionalComments.comment

Represents the actual comment of the object.

entryFormat

Represents the format of the entry being recorded. Valid values are additive or cumulative.

isCancelled

Used to specify if the order is cancelled or not.

Hedge Schema¶

Example JSON

{
  "createdBy": "string",
  "createdDateTime": "2020-04-17T03:22:19.284Z",
  "lastModifiedBy": "string",
  "lastModifiedDateTime": "2020-04-17T03:22:19.284Z",
  "companyId": 0,
  "indicationId": "string",
  "sourceId": "string",
  "hedgeBasis": {
        "intendTo": "hedge",
        "detail": {
          "type": "hedge",
          "subType": "durationWeight",
          "data": {
                "reference": {
                  "type": "security",
                  "name": "string",
                  "identificationType": "symbol",
                  "identificationCode": "string"
                },
                "settlement": {
                  "tradeDateOffset": 0,
                  "date": "2020-04-17T03:22:19.284Z",
                  "price": 0
                }
          },
          "value": {
                "type": "amount",
                "data": {
                  "amount": 0
                }
          }
        }
  },
  "dealId": "string",
  "trancheId": "string",
  "sourceRowVersion": "string",
  "orderStatus": "pending",
  "indicationGroupId": "string",
  "statusMessages": [
        {
          "code": "string",
          "message": "string"
        }
  ]
}

createdBy

Represents user Id who creates this Hedge.

createdDateTime

Created datetime for this Hedge.

lastModifiedBy

Represents user Id who last modified this Hedge.

lastModifiedDateTime

Last modified datetime for this Hedge.

companyId

Company ID associated with this Hedge.

indicationId

Represents the ID of the Indication this Hedge belongs to.

sourceId

Represents the ID of the Hedge in the source application, if applicable.

hedgeBasis.intendTo

Represents the hedge basis type. Valid values are hedge, switch, assetSwap, cash, oneOffHedge, or exchangeOfFuturesForPhysical.

hedgeBasis.detail.type

Represents the type of hedge basis. Valid values are hedge, switch, assetSwap, cash, oneOffHedge, or exchangeOfFuturesForPhysical.

hedgeBasis.detail.subType

Represents the hedge sub type. Valid values are durationWeight, notionalVsNotional, cashVsCash, parVsPar, yieldVsYield or amount.

hedgeBasis.detail.data.reference.type

Represents the hedge reference type. Valid values are security or assetSwap.

hedgeBasis.detail.data.reference.name

Represents the hedge reference name.

hedgeBasis.detail.data.reference.identificationType

Represents the identification type of the Hedge. Valid values are symbol, cusip, isin, sedol, or ric.

hedgeBasis.detail.data.reference.identificationCode

Represents the security identification code

hedgeBasis.detail.data.settlement.tradeDateOffset

Represents the settlement date offset.

hedgeBasis.detail.data.settlement.date

Represents the settlement date.

hedgeBasis.detail.data.settlement.price

Represents the settlement price.

hedgeBasis.detail.value.type

Represents the hedge value type. Valid values are amount, or percentage.

hedgeBasis.detail.value.data.amount

Represents the value amount of the Hedge.

dealId

Represents the ID of the deal for this Hedge.

trancheId

Represents the ID of the tranche of the deal this Hedge is for.

sourceRowVersion

Used for concurrency check in the source system, if applicable.

orderStatus

Represents the status of the order. Valid values are pending, delivered, successful, failed, or deletePending.

indicationGroupId

Represents the ID of the Indication Group this Hedge belongs to.

statusMessages

code: Represents the code for the status message of this Hedge.
message: Represents the message of the status for this Hedge.

Indication Group Schema¶

Example JSON

{
    "createdBy": "string",
    "createdDateTime": "2019-10-17T13:26:00.822Z",
    "dealId": "string",
    "trancheId": "string",
    "sourceId": "string",
    "lastModifiedBy": "string",
    "lastModifiedDateTime": "2019-10-17T13:26:00.822Z",
    "isCancelled": true,
    "indicationGroupData": {
        "billDeliveryData": {
            "brokerPmid": "string",
            "brokerName": "string",
            "brokerCode": "string"
        }
    },
    "sourceRowVersion": "string"
}

createdBy

Represents user Id who creates this Indication Group.

createdDateTime

Created datetime for this Indication Group.

dealId

Represents the ID of the deal for this Indication Group.

trancheId

Represents the ID of the tranche of the deal this Indication Group is for.

sourceId

Represents the ID of the Indication Group in the source application, if applicable.

lastModifiedBy

Represents user Id who last modified this Indication Group.

lastModifiedDateTime

Last modified datetime for this Indication Group.

isCancelled

Represents if the Indication Group is cancelled or not.

indicationGroupData

billDeliveryData

brokerPmid: Represents the PMID of the broker.
brokerName: Represents the name of the broker.
brokerCode: Represents the code of the broker.

sourceRowVersion

Used for concurrency check in the source application system, if applicable.

isCancelled

Used to specify if the order is cancelled or not.