# SetExtraReportingDataResponseBasketOrder

The basket order that was updated

## Example Usage

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

let value: SetExtraReportingDataResponseBasketOrder = {};
```

## 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. This 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.SetExtraReportingDataResponseAssetType](../../models/components/setextrareportingdataresponseassettype.md)                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The type of the asset in this order                                                                                                                                                                                                                                                                                                               | EQUITY                                                                                                                                                                                                                                                                                                                                            |
| `averagePrices`                                                                                                                                                                                                                                                                                                                                   | [components.BasketTradingExecutedPrice](../../models/components/baskettradingexecutedprice.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.<br/><br/> When asset_type = EQUITY, 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. | [<br/>{<br/>"price": {<br/>"value": "99.20"<br/>},<br/>"type": "PRICE_PER_UNIT"<br/>}<br/>]                                                                                                                                                                                                                                                       |
| `basketOrderId`                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | System generated unique id for the basket order.                                                                                                                                                                                                                                                                                                  | ebb0c9b5-2c74-45c9-a4ab-40596b778706                                                                                                                                                                                                                                                                                                              |
| `cancelInitiator`                                                                                                                                                                                                                                                                                                                                 | [components.SetExtraReportingDataResponseCancelInitiator](../../models/components/setextrareportingdataresponsecancelinitiator.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 RemoveOrderRequest                                                                                               | FIRM                                                                                                                                                                                                                                                                                                                                              |
| `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 RemoveOrderRequest                                                                                                                                                                                             | 2023-09-21T16:55:27.580Z                                                                                                                                                                                                                                                                                                                          |
| `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 RemoveOrderRequest                                                                                                                                                                                             | 2023-09-21T16:55:27.580Z                                                                                                                                                                                                                                                                                                                          |
| `clientOrderId`                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | 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                                                                                                                                                                                                                                                                                                                          |
| `createTime`                                                                                                                                                                                                                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | Time of the order creation                                                                                                                                                                                                                                                                                                                        | 2023-09-21T16:55:27.580Z                                                                                                                                                                                                                                                                                                                          |
| `cumulativeNotionalValue`                                                                                                                                                                                                                                                                                                                         | [components.SetExtraReportingDataResponseCumulativeNotionalValue](../../models/components/setextrareportingdataresponsecumulativenotionalvalue.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The product of order quantity & price, summed 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.                                                                                                               | {<br/>"value": "120.68"<br/>}                                                                                                                                                                                                                                                                                                                     |
| `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.BasketTradingExecutions](../../models/components/baskettradingexecutions.md)[]                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The execution-level details that compose this order                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                   |
| `extraReportingData`                                                                                                                                                                                                                                                                                                                              | [components.SetExtraReportingDataResponseExtraReportingData](../../models/components/setextrareportingdataresponseextrareportingdata.md)                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | Any reporting data provided by the SetExtraReportingData endpoint.                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                   |
| `filledQuantity`                                                                                                                                                                                                                                                                                                                                  | [components.SetExtraReportingDataResponseFilledQuantity](../../models/components/setextrareportingdataresponsefilledquantity.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.                                                                                                                                                                                                | {<br/>"value": "10.64208"<br/>}                                                                                                                                                                                                                                                                                                                   |
| `identifier`                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | Identifier of the asset (of the type specified in `identifier_type`).                                                                                                                                                                                                                                                                             | SBUX                                                                                                                                                                                                                                                                                                                                              |
| `identifierType`                                                                                                                                                                                                                                                                                                                                  | [components.SetExtraReportingDataResponseIdentifierType](../../models/components/setextrareportingdataresponseidentifiertype.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                                                                                                                                                                                                      | 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                                                                                                                                                                                                                                                                                                                     | 2023-09-21T16:55:27.580Z                                                                                                                                                                                                                                                                                                                          |
| `maxSellQuantity`                                                                                                                                                                                                                                                                                                                                 | [components.SetExtraReportingDataResponseMaxSellQuantity](../../models/components/setextrareportingdataresponsemaxsellquantity.md)                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The maximum number of shares to be sold if this is a notional SELL order of an Equity asset type. (Prohibited for other side or asset_type inputs.)<br/><br/> This will only be recognized for clients configured to bypass the short sale risk check. When specified, must be greater than 0 and can't exceed 5 decimal places.                  | {<br/>"value": "20.55219"<br/>}                                                                                                                                                                                                                                                                                                                   |
| `name`                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | System generated name of the basket order.                                                                                                                                                                                                                                                                                                        | correspondents/01HPMZZM6RKMVZA1JQ63RQKJRP/baskets/fffd326-72fa-4d2b-bd1f-45384fe5d521/basketOrders/ebb0c9b5-2c74-45c9-a4ab-40596b778706                                                                                                                                                                                                           |
| `notionalValue`                                                                                                                                                                                                                                                                                                                                   | [components.SetExtraReportingDataResponseNotionalValue](../../models/components/setextrareportingdataresponsenotionalvalue.md)                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | Notional quantity of the order, measured in USD. Maximum 2 decimal place precision. Either a quantity or notional_value MUST be specified (but not both). For Equities: currently not supported yet For Mutual Funds: Only supported for BUY orders. The order will be transacted at the full notional amount specified.                          | {<br/>"value": "100.54"<br/>}                                                                                                                                                                                                                                                                                                                     |
| `orderRejectedReason`                                                                                                                                                                                                                                                                                                                             | [components.SetExtraReportingDataResponseOrderRejectedReason](../../models/components/setextrareportingdataresponseorderrejectedreason.md)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | When an order has the REJECTED status, this will be populated with a system code describing the rejection.                                                                                                                                                                                                                                        | BELOW_NOTIONAL_MINIMUM                                                                                                                                                                                                                                                                                                                            |
| `orderStatus`                                                                                                                                                                                                                                                                                                                                     | [components.SetExtraReportingDataResponseOrderStatus](../../models/components/setextrareportingdataresponseorderstatus.md)                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The processing status of the order                                                                                                                                                                                                                                                                                                                | FILLED                                                                                                                                                                                                                                                                                                                                            |
| `orderType`                                                                                                                                                                                                                                                                                                                                       | [components.SetExtraReportingDataResponseOrderType](../../models/components/setextrareportingdataresponseordertype.md)                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The execution type of this order.                                                                                                                                                                                                                                                                                                                 | MARKET                                                                                                                                                                                                                                                                                                                                            |
| `quantity`                                                                                                                                                                                                                                                                                                                                        | [components.SetExtraReportingDataResponseQuantity](../../models/components/setextrareportingdataresponsequantity.md)                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | Numeric quantity of the order. Either a quantity or notional_value MUST be specified (but not both). 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.        | {<br/>"value": "20.55219"<br/>}                                                                                                                                                                                                                                                                                                                   |
| `side`                                                                                                                                                                                                                                                                                                                                            | [components.SetExtraReportingDataResponseSide](../../models/components/setextrareportingdataresponseside.md)                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | The side of this order.                                                                                                                                                                                                                                                                                                                           | BUY                                                                                                                                                                                                                                                                                                                                               |
| `specialReportingInstructions`                                                                                                                                                                                                                                                                                                                    | [components.SetExtraReportingDataResponseSpecialReportingInstructions](../../models/components/setextrareportingdataresponsespecialreportinginstructions.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.SetExtraReportingDataResponseTimeInForce](../../models/components/setextrareportingdataresponsetimeinforce.md)                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                | 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                                                                                                                                                                                                                                                                                                                                               |