# OrderCreate
The message describing an order
## Example Usage
```typescript
import { AssetType, OrderCreate, OrderCreateIdentifierType, OrderType, Side, TimeInForce } from "@apexfintechsolutions/ascend-sdk/models/components";
let value: OrderCreate = {
assetType: AssetType.Equity,
clientOrderId: "a6d5258b-6b23-478a-8145-98e79d60427a",
identifier: "SBUX",
identifierType: OrderCreateIdentifierType.Symbol,
orderDate: {},
orderType: OrderType.Market,
side: Side.Buy,
timeInForce: TimeInForce.Day,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `assetType` | [components.AssetType](../../models/components/assettype.md) | :heavy_check_mark: | The type of the asset in this order, which must be one of the following:
EQUITY, MUTUAL_FUND, and FIXED_INCOME. | EQUITY |
| `brokerCapacity` | [components.BrokerCapacity](../../models/components/brokercapacity.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 |
| `clientOrderId` | *string* | :heavy_check_mark: | 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.CommissionCreate](../../models/components/commissioncreate.md) | :heavy_minus_sign: | A custom commission applied to an order | |
| `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 |
| `fees` | [components.FeeCreate](../../models/components/feecreate.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"
}
] |
| `identifier` | *string* | :heavy_check_mark: | 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.OrderCreateIdentifierType](../../models/components/ordercreateidentifiertype.md) | :heavy_check_mark: | 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 |
| `letterOfIntent` | [components.LetterOfIntentCreate](../../models/components/letterofintentcreate.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. | |
| `limitPrice` | [components.LimitPriceCreate](../../models/components/limitpricecreate.md) | :heavy_minus_sign: | A limit price definition | |
| `maxSellQuantity` | [components.DecimalCreate](../../models/components/decimalcreate.md) | :heavy_minus_sign: | A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
[BigDecimal]:
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html
[decimal.Decimal]: https://docs.python.org/3/library/decimal.html | |
| `notionalValue` | [components.DecimalCreate](../../models/components/decimalcreate.md) | :heavy_minus_sign: | A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
[BigDecimal]:
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html
[decimal.Decimal]: https://docs.python.org/3/library/decimal.html | |
| `orderDate` | [components.DateCreate](../../models/components/datecreate.md) | :heavy_check_mark: | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
* A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. | |
| `orderType` | [components.OrderType](../../models/components/ordertype.md) | :heavy_check_mark: | 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 |
| `quantity` | [components.DecimalCreate](../../models/components/decimalcreate.md) | :heavy_minus_sign: | A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
[BigDecimal]:
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html
[decimal.Decimal]: https://docs.python.org/3/library/decimal.html | |
| `rightsOfAccumulation` | [components.RightsOfAccumulationCreate](../../models/components/rightsofaccumulationcreate.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. | |
| `side` | [components.Side](../../models/components/side.md) | :heavy_check_mark: | The side of this order. | BUY |
| `specialReportingInstructions` | [components.SpecialReportingInstructions](../../models/components/specialreportinginstructions.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.StopPriceCreate](../../models/components/stoppricecreate.md) | :heavy_minus_sign: | A stop price definition | |
| `timeInForce` | [components.TimeInForce](../../models/components/timeinforce.md) | :heavy_check_mark: | 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.DateCreate](../../models/components/datecreate.md) | :heavy_minus_sign: | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
* A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`. | |
| `tradingSession` | [components.TradingSession](../../models/components/tradingsession.md) | :heavy_minus_sign: | Which TradingSession to trade in, defaults to 'CORE'. Only available for Equity orders. | CORE |