# Order
The message describing an order
## Example Usage
```typescript
import { Order } from "@apexfintechsolutions/ascend-sdk/models/components";
let value: Order = {};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_minus_sign: | The identifier of the account transacting this order | 01HBRQ5BW6ZAY4BNWP4GWRD80X |
| `assetId` | *string* | :heavy_minus_sign: | Apex Asset ID for this asset. When the identifier_type is not ASSET_ID, this field will not be returned in the initial CreateOrder response and will be available after an order completes validation. If the provided identifier does not match any Apex asset available for trading, an OrderRejectReason of "UNKNOWN_SECURITY" will be returned and the asset_id will not be set. | 22091 |
| `assetType` | [components.OrderAssetType](../../models/components/orderassettype.md) | :heavy_minus_sign: | The type of the asset in this order, which must be one of the following:
EQUITY, MUTUAL_FUND, and FIXED_INCOME. | EQUITY |
| `averagePrices` | [components.TradingExecutedPrice](../../models/components/tradingexecutedprice.md)[] | :heavy_minus_sign: | The average prices, as weighted averages, across all executions in this order. Will be absent if an order has no executions.
When asset_type = EQUITY or MUTUAL_FUND, there will be at most one value present, with a type of PRICE_PER_UNIT. This will have up to 4 decimal places for USD amounts less than $1, and a maximum of two for larger USD amounts.
When asset_type = FIXED_INCOME, there may be more than one value present which would have a type other than PRICE_PER_UNIT. Price values in PERCENTAGE_OF_PAR will have up to 8 decimal places of precision, and price values measured in yields will support up to 7 decimal places. | [
{
"price": {
"value": "99.20"
},
"type": "PRICE_PER_UNIT"
}
] |
| `brokerCapacity` | [components.OrderBrokerCapacity](../../models/components/orderbrokercapacity.md) | :heavy_minus_sign: | Defaults to "AGENCY" if not specified, except for Fixed Income orders from RIA correspondents which default to "PRINCIPAL" when not specified. For Equities: Only "AGENCY" is allowed. For Mutual Funds: Only "AGENCY" is allowed. For Fixed Income: Either "AGENCY" or "PRINCIPAL" are allowed. - RIA correspondents: Defaults to "PRINCIPAL" if not specified. - Other correspondents: Defaults to "AGENCY" if not specified. For Event Contracts: Only "AGENCY" is allowed. | AGENCY |
| `cancelInitiator` | [components.CancelInitiator](../../models/components/cancelinitiator.md) | :heavy_minus_sign: | Output only field that is required for Equity Orders for any client who is having Apex do CAT reporting on their behalf. This field denotes the initiator of the cancel request. This field will be present when provided on the CancelOrderRequest | FIRM |
| `cancelReason` | *string* | :heavy_minus_sign: | Used to explain why an order is canceled | |
| `cancelRejectedReason` | [components.CancelRejectedReason](../../models/components/cancelrejectedreason.md) | :heavy_minus_sign: | Used to denote when a cancel request has been rejected. | TOO_LATE_TO_CANCEL |
| `clientCancelReceivedTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Output only field for Equity Orders related to CAT reporting on behalf of clients. This field will be present when provided on the CancelOrderRequest | |
| `clientCancelSentTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Output only field for Equity Orders related to CAT reporting on behalf of clients. This field will be present when provided on the CancelOrderRequest | |
| `clientOrderId` | *string* | :heavy_minus_sign: | User-supplied unique order ID. Cannot be more than 40 characters long. | a6d5258b-6b23-478a-8145-98e79d60427a |
| `clientReceivedTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Required for Equity Orders for any client who is having Apex do CAT reporting on their behalf. A value may be provided for non-Equity orders, and will be remembered, but valid timestamps will have no impact on how they are processed. | {"seconds": 1712081516, "nanos": 902000000} |
| `clientSentTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Only relevant for CAT reporting when clients have Apex do CAT reporting on their behalf. Denotes the time the client sent the order to Apex. A value may be provided for non-Equity orders, and will be remembered, but valid timestamps will have no impact on how they are processed. | {"seconds": 1712081516, "nanos": 902000000} |
| `commission` | [components.OrderCommission](../../models/components/ordercommission.md) | :heavy_minus_sign: | A custom commission to be applied to this order. When specifying an AMOUNT type, the value represents a notional amount measured in the currency of the order. Only available for Equity, Mutual Fund, and Fixed Income orders. | {
"type": "AMOUNT",
"value": {
"value": "30.14"
}
} |
| `createTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Time of the order creation | {"seconds": 1712081516, "nanos": 902000000} |
| `cumulativeNotionalValue` | [components.CumulativeNotionalValue](../../models/components/cumulativenotionalvalue.md) | :heavy_minus_sign: | The sum of order quantity & price, across all fills, reported in the currency specified in the order. (This will be rounded to 2 decimal places for USD currencies). Will be absent if an order has no fill information. | {
"value": "120.68"
} |
| `currencyCode` | *string* | :heavy_minus_sign: | Defaults to "USD". Only "USD" is supported. Full list of currency codes is defined at: https://en.wikipedia.org/wiki/ISO_4217 | USD |
| `executions` | [components.TradingExecutions](../../models/components/tradingexecutions.md)[] | :heavy_minus_sign: | The execution-level details that compose this order | |
| `extraReportingData` | [components.ExtraReportingData](../../models/components/extrareportingdata.md) | :heavy_minus_sign: | Any reporting data provided by the SetExtraReportingData endpoint. | |
| `fees` | [components.TradingFee](../../models/components/tradingfee.md)[] | :heavy_minus_sign: | Fees that will be applied to this order. Only the BROKER_FEE type is supported. | [
{
"amount": {
"value": "5.00"
},
"type": "BROKER_FEE"
}
] |
| `filledQuantity` | [components.FilledQuantity](../../models/components/filledquantity.md) | :heavy_minus_sign: | The summed quantity value across all fills in this order, up to a maximum of 5 decimal places. Will be absent if an order has no fill information. | FILLED |
| `identifier` | *string* | :heavy_minus_sign: | Identifier of the asset (of the type specified in `identifier_type`). | SBUX |
| `identifierIssuingRegionCode` | *string* | :heavy_minus_sign: | A string attribute denoting the country of issuance or where the asset is trading. * Only available for Mutual Fund and Fixed Income orders. * Only available when the identifier_type is SYMBOL or CUSIP. * Defaults to US when the identifier_type is SYMBOL or CUSIP. * Complies with ISO-3166 Alpha-2 Codes | US |
| `identifierType` | [components.OrderIdentifierType](../../models/components/orderidentifiertype.md) | :heavy_minus_sign: | The identifier type of the asset being ordered. For Equities: only SYMBOL is supported For Mutual Funds: only SYMBOL and CUSIP are supported For Fixed Income: only CUSIP and ISIN are supported For Event Contracts: only SYMBOL and ASSET_ID are supported | SYMBOL |
| `lastUpdateTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Time of the last order update | {"seconds": 1712081569, "nanos": 360000000} |
| `letterOfIntent` | [components.LetterOfIntent](../../models/components/letterofintent.md) | :heavy_minus_sign: | Letter of Intent (LOI). An LOI allows investors to receive sales charge discounts based on a commitment to buy a specified monetary amount of shares over a period of time, usually 13 months. | {
"amount": {
"value": "9999999.99"
},
"period_start_date": {
"day": 25,
"month": 4,
"year": 2024
}
} |
| `limitPrice` | [components.LimitPrice](../../models/components/limitprice.md) | :heavy_minus_sign: | The limit price for this order. | {
"price": {
"value": "95.99"
},
"type": "PRICE_PER_UNIT"
} |
| `maxSellQuantity` | [components.MaxSellQuantity](../../models/components/maxsellquantity.md) | :heavy_minus_sign: | The maximum number of shares to be sold for a notional SELL order of an Equity asset type. This field restricts the quantity to sell, even if the notional amount requires more shares to fulfill. REQUIRED if your account is not subject to Apex position checks, and PROHIBITED if your account is subject to Apex position checks. Refer to Position Check for details. When specified, must be greater than 0 and can't exceed 5 decimal places. | {
"value": "20.55219"
} |
| `name` | *string* | :heavy_minus_sign: | System generated name of the order. | accounts/01HBRQ5BW6ZAY4BNWP4GWRD80X/orders/ebb0c9b5-2c74-45c9-a4ab-40596b778706 |
| `notionalValue` | [components.NotionalValue](../../models/components/notionalvalue.md) | :heavy_minus_sign: | Notional quantity of the order, measured in USD. Maximum 2 decimal place precision. For Equities: This represents the maximum amount to be spent. The final order may may have a smaller notional amount. For Mutual Funds: Only supported for BUY orders. The order will be transacted at the full notional amount specified. For Fixed Income: Not supported, you must specify a `quantity` value. For Event Contracts: Not supported, you must specify a `quantity` value. | {
"value": "100.54"
} |
| `open` | *boolean* | :heavy_minus_sign: | A value derived from the order_status, indicating whether the order is still open. The statuses that indicate an order is open are: PENDING_NEW, NEW, PENDING_QUEUED, QUEUED, PARTIALLY_FILLED, and PENDING_CANCEL. An order with any other status is not considered open. | |
| `orderDate` | [components.OrderDate](../../models/components/orderdate.md) | :heavy_minus_sign: | The date on which the order will go to the market: must either be "today" or the next valid trading day. If the current day is not a valid trading day, then the next valid market day must be specified. If the current time is after market close, and before midnight Eastern, then the next valid market day must be specified. In all other cases, the current day, Eastern must be specified. | {
"day": 25,
"month": 4,
"year": 2024
} |
| `orderId` | *string* | :heavy_minus_sign: | System generated unique id for the order. | ebb0c9b5-2c74-45c9-a4ab-40596b778706 |
| `orderRejectedReason` | [components.OrderRejectedReason](../../models/components/orderrejectedreason.md) | :heavy_minus_sign: | When an order has the REJECTED status, this will be populated with a system code describing the rejection. | FAILED_BUYING_POWER |
| `orderStatus` | [components.OrderStatus](../../models/components/orderstatus.md) | :heavy_minus_sign: | The processing status of the order | FILLED |
| `orderType` | [components.OrderOrderType](../../models/components/orderordertype.md) | :heavy_minus_sign: | The execution type of this order. For Equities: MARKET, LIMIT, STOP and MARKET_IF_TOUCHED are supported. For Mutual Funds: only MARKET is supported. For Fixed Income: only LIMIT is supported. For Event Contracts: only MARKET and LIMIT are supported. | MARKET |
| `prevailingMarketPrice` | [components.OrderPrevailingMarketPrice](../../models/components/orderprevailingmarketprice.md) | :heavy_minus_sign: | The prevailing market price, calculated as a weighted average of the fills in this order, up to a maximum of 5 decimal places. Can be up to 8 decimal places when asset_type = FIXED_INCOME. Will be absent if an order has no executions. | {
"value": "99.20"
} |
| `quantity` | [components.OrderQuantity](../../models/components/orderquantity.md) | :heavy_minus_sign: | Numeric quantity of the order. For Equities: Represents the number of shares, must be greater than zero and may not exceed 5 decimal places. For Mutual Funds: Only supported for SELL orders. Represents the number of shares, up to a maximum of 3 decimal places. For Fixed Income: Represents the par (face-value) amount being ordered, and may not exceed two decimal places for USD-based currencies. For Event Contracts: Represents the number of contracts being ordered, and must be whole numbers for BUY orders or up to a maximum of 2 decimal places for SELL orders. Either a quantity or notional_value MUST be specified (but not both). | {
"value": "20.55219"
} |
| `rightsOfAccumulation` | [components.RightsOfAccumulation](../../models/components/rightsofaccumulation.md) | :heavy_minus_sign: | Rights of Accumulation (ROA). An ROA allows an investor to aggregate their own fund shares with the holdings of certain related parties toward achieving the investment thresholds at which sales charge discounts become available. | {
"amount": {
"value": "9999999.99"
}
} |
| `side` | [components.OrderSide](../../models/components/orderside.md) | :heavy_minus_sign: | The side of this order. | BUY |
| `specialReportingInstructions` | [components.OrderSpecialReportingInstructions](../../models/components/orderspecialreportinginstructions.md)[] | :heavy_minus_sign: | Special Reporting Instructions to be applied to this order. Can include multiple Instructions. Only available for Equity, Mutual Fund, and Fixed Income orders. | [
"RISKLESS_PRINCIPAL",
"WITH_RIGHTS"
] |
| `stopPrice` | [components.StopPrice](../../models/components/stopprice.md) | :heavy_minus_sign: | The stop price for this order. Only allowed for equities. | {
"price": {
"value": "88.132"
},
"type": "PRICE_PER_UNIT"
} |
| `timeInForce` | [components.OrderTimeInForce](../../models/components/ordertimeinforce.md) | :heavy_minus_sign: | For Equities: Either "DAY" or "GOOD_TILL_DATE" are allowed. For Mutual Funds: Only "DAY" is allowed. For Fixed Income: Only "DAY" is allowed. For Event Contracts: Either "DAY", "GOOD_TILL_DATE", "GOOD_TILL_CANCELED", "IMMEDIATE_OR_CANCEL", or "FILL_OR_KILL" are allowed. | DAY |
| `timeInForceExpirationDate` | [components.TimeInForceExpirationDate](../../models/components/timeinforceexpirationdate.md) | :heavy_minus_sign: | The date till which a GOOD_TILL_DATE order will remain valid. If the order is a STOP/MIT order with TimeInForce as GOOD_TILL_DATE, then this must be populated. | {
"day": 29,
"month": 7,
"year": 2025
} |
| `tradingSession` | [components.OrderTradingSession](../../models/components/ordertradingsession.md) | :heavy_minus_sign: | Which TradingSession to trade in, defaults to 'CORE'. Only available for Equity orders. | CORE |