Preferred¶

Preferred Deals

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 Deals`_	Get	/v1/deals/fixed-income/preferred	Get all preferred deals with optional search criteria
`Get Deal`_	Get	/v1/deals/fixed-income/preferred/{id}	Get a specific preferred deal
`Create Deal`_	Post	/v1/deals/fixed-income/preferred	Create a preferred deal
`Update Deal`_	Put	/v1/deals/fixed-income/preferred/{id}	Update a specific preferred deal
`Update Deal by Source Id`_	Put	/v1/deals/fixed-income/preferred	Update a specific preferred deal by source application id
Patch Deal	Patch	/v1/deals/fixed-income/preferred/{id}	Update a subset of the attributes of an existing Deal
Create Tranche For Deal	Post	/v1/tranches/fixed-income/preferred	Create a tranche for a preferred deal

Patch Deal¶

The patch deal endpoint provides a way of updating specific fields of an existing Deals object.

Authorization¶

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

Parameters¶

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

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

Response¶

The endpoint returns a JSON payload containing the new, updated Deal Object if successful.

Create Tranche For Deal¶

The create tranche endpoint provides a way of creating one or more tranche objects in the CAS system for an existing preferred deal object in the CAS system.

Authorization¶

In order to create the tranche information, it is required to have the deals-write scope in the access token.

Parameters¶

N/A

Response¶

The endpoint returns a json payload containing one or more Tranche Objects reflecting the objects that were just created.