# BasketOrderCreate

The message describing an order that has been added to a basket

## Example Usage

```typescript
import {
  BasketOrderCreate,
  BasketOrderCreateAssetType,
  BasketOrderCreateIdentifierType,
  BasketOrderCreateOrderType,
  BasketOrderCreateSide,
  BasketOrderCreateTimeInForce,
} from "@apexfintechsolutions/ascend-sdk/models/components";

let value: BasketOrderCreate = {
  accountId: "01HBRQ5BW6ZAY4BNWP4GWRD80X",
  assetType: BasketOrderCreateAssetType.Equity,
  clientOrderId: "a6d5258b-6b23-478a-8145-98e79d60427a",
  identifier: "SBUX",
  identifierType: BasketOrderCreateIdentifierType.Symbol,
  orderType: BasketOrderCreateOrderType.Market,
  side: BasketOrderCreateSide.Buy,
  timeInForce: BasketOrderCreateTimeInForce.Day,
};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                        | Type                                                                                                                                                                                                                                                                                                                                                         | Required                                                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                  | Example                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId`                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | The identifier of the account transacting this order                                                                                                                                                                                                                                                                                                         | 01HBRQ5BW6ZAY4BNWP4GWRD80X                                                                                                                                                                                                                                                                                                                                   |
| `assetType`                                                                                                                                                                                                                                                                                                                                                  | [components.BasketOrderCreateAssetType](../../models/components/basketordercreateassettype.md)                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | The type of the asset in this order                                                                                                                                                                                                                                                                                                                          | EQUITY                                                                                                                                                                                                                                                                                                                                                       |
| `clientOrderId`                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | User-supplied unique order ID. Cannot be more than 40 characters long.                                                                                                                                                                                                                                                                                       | a6d5258b-6b23-478a-8145-98e79d60427a                                                                                                                                                                                                                                                                                                                         |
| `clientOrderReceivedTime`                                                                                                                                                                                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | Time the order request was received by the client. Must be in the past. Timezone will default to UTC if not provided.                                                                                                                                                                                                                                        | 2023-09-21T16:55:27.580Z                                                                                                                                                                                                                                                                                                                                     |
| `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                                                                                                                                                                                                                                                                                                                                                          |
| `extraReportingData`                                                                                                                                                                                                                                                                                                                                         | [components.ExtraReportingDataCreate](../../models/components/extrareportingdatacreate.md)                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | Any extra reporting data provided by the client for an order                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                              |
| `identifier`                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | Identifier of the asset (of the type specified in `identifier_type`).                                                                                                                                                                                                                                                                                        | SBUX                                                                                                                                                                                                                                                                                                                                                         |
| `identifierType`                                                                                                                                                                                                                                                                                                                                             | [components.BasketOrderCreateIdentifierType](../../models/components/basketordercreateidentifiertype.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                                                                                                                                                                                                                 | SYMBOL                                                                                                                                                                                                                                                                                                                                                       |
| `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][].<br/><br/> [BigDecimal]:<br/> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html<br/> [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][].<br/><br/> [BigDecimal]:<br/> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html<br/> [decimal.Decimal]: https://docs.python.org/3/library/decimal.html |                                                                                                                                                                                                                                                                                                                                                              |
| `orderType`                                                                                                                                                                                                                                                                                                                                                  | [components.BasketOrderCreateOrderType](../../models/components/basketordercreateordertype.md)                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | The execution type of this order.                                                                                                                                                                                                                                                                                                                            | 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][].<br/><br/> [BigDecimal]:<br/> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html<br/> [decimal.Decimal]: https://docs.python.org/3/library/decimal.html |                                                                                                                                                                                                                                                                                                                                                              |
| `side`                                                                                                                                                                                                                                                                                                                                                       | [components.BasketOrderCreateSide](../../models/components/basketordercreateside.md)                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | The side of this order.                                                                                                                                                                                                                                                                                                                                      | BUY                                                                                                                                                                                                                                                                                                                                                          |
| `specialReportingInstructions`                                                                                                                                                                                                                                                                                                                               | [components.BasketOrderCreateSpecialReportingInstructions](../../models/components/basketordercreatespecialreportinginstructions.md)[]                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | Special Reporting Instructions to be applied to this order. Can include multiple Instructions.                                                                                                                                                                                                                                                               | [<br/>"UNSOLICITED",<br/>"ROUND_UP"<br/>]                                                                                                                                                                                                                                                                                                                    |
| `timeInForce`                                                                                                                                                                                                                                                                                                                                                | [components.BasketOrderCreateTimeInForce](../../models/components/basketordercreatetimeinforce.md)                                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | Must be the value "DAY". Regulatory requirements dictate that the system capture the intended time_in_force, which is why this a mandatory field.                                                                                                                                                                                                            | DAY                                                                                                                                                                                                                                                                                                                                                          |