# Allocation

Object containing metadata for trade allocation

## Example Usage

```typescript
import { Allocation } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: Allocation = {};
```

## Fields

| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    | Example                                                                                        |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `additionalInstructions`                                                                       | *string*[]                                                                                     | :heavy_minus_sign:                                                                             | To be populated by the submitter of the trade detail                                           | [<br/>"As-Of Allocation Example",<br/>"to Cancel"<br/>]                                        |
| `bookingApiTradeAllocationId`                                                                  | *string*                                                                                       | :heavy_minus_sign:                                                                             | ULID assigned by the Booking API if a trade belongs to an allocation                           | 01HYKYBD00JBQAZ8477RD1M8T7                                                                     |
| `brokerCapacity`                                                                               | [components.EntryBrokerCapacity](../../models/components/entrybrokercapacity.md)               | :heavy_minus_sign:                                                                             | The execution route Apex used for this trade                                                   | MNGD                                                                                           |
| `clientMemo`                                                                                   | *string*                                                                                       | :heavy_minus_sign:                                                                             | Client usage area (intact)                                                                     | Detail from client                                                                             |
| `clientOrderId`                                                                                | *string*                                                                                       | :heavy_minus_sign:                                                                             | Client-provided order ID present in execution reports                                          | 0db56450                                                                                       |
| `externalId`                                                                                   | *string*                                                                                       | :heavy_minus_sign:                                                                             | External system ID provided by a client                                                        | 01HAWHW7PSNS99H9SSCY3J3MXZ_FROM_STREET-SELL-393767f7-0db5645                                   |
| `gatewayClientOrderId`                                                                         | *string*                                                                                       | :heavy_minus_sign:                                                                             | Order ID generated by the trading-gateway                                                      | 7039acda                                                                                       |
| `internalError`                                                                                | *boolean*                                                                                      | :heavy_minus_sign:                                                                             | Indicates the trade should be omitted from client billing                                      | false                                                                                          |
| `lots`                                                                                         | [components.Lot](../../models/components/lot.md)[]                                             | :heavy_minus_sign:                                                                             | Trade lots                                                                                     |                                                                                                |
| `prevailingMarketPrice`                                                                        | [components.EntryPrevailingMarketPrice](../../models/components/entryprevailingmarketprice.md) | :heavy_minus_sign:                                                                             | The price for the instrument that is prevailing in the market                                  | {<br/>"value": "0.25"<br/>}                                                                    |
| `priceAdjustmentRecord`                                                                        | [components.PriceAdjustmentRecord](../../models/components/priceadjustmentrecord.md)           | :heavy_minus_sign:                                                                             | Information about any price adjustments applied to the security                                |                                                                                                |
| `specialInstructions`                                                                          | *string*[]                                                                                     | :heavy_minus_sign:                                                                             | Special instructions for the trade                                                             | [<br/>"WITH_DIVIDEND",<br/>"OPTION_ASSIGNMENT"<br/>]                                           |
| `yieldRecords`                                                                                 | [components.YieldRecord](../../models/components/yieldrecord.md)[]                             | :heavy_minus_sign:                                                                             | The yields associated with a fixed income trade                                                |                                                                                                |