# AlternativeOrder
An order for an alternative investment.
## Example Usage
```typescript
import { AlternativeOrder } from "@apexfintechsolutions/ascend-sdk/models/components";
let value: AlternativeOrder = {};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_minus_sign: | The ID of the account. | 01JR8YQT40WAQT8S95ZQGS1QN0 |
| `alternativeOrderId` | *string* | :heavy_minus_sign: | The ID of the alternative investment order. | 01H5TSDAD9MQ98B8KF36J3Q8P9 |
| `clientOrderId` | *string* | :heavy_minus_sign: | A client-supplied unique ID to enforce idempotency. Each ID must be unique within the account.
If a create request includes a `client_order_id` that matches an existing order’s `client_order_id`, the service will respond with `ALREADY_EXISTS` and will not create a new order resource. | f5074670-1b25-439f-9b5c-702027660800 |
| `createTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the order was created. Uses [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). | 2023-10-01T12:00:00Z |
| `cumulativeNotionalValue` | [components.AlternativeOrderCumulativeNotionalValue](../../models/components/alternativeordercumulativenotionalvalue.md) | :heavy_minus_sign: | The actual amount of the order, which is determined after the issuer accepts the order. May differ from the requested `notional_value`. | |
| `currencyCode` | *string* | :heavy_minus_sign: | The currency code of the order. Supports only "USD" and will default to "USD" if unspecified in the request. | USD |
| `distributionType` | [components.AlternativeOrderDistributionType](../../models/components/alternativeorderdistributiontype.md) | :heavy_minus_sign: | Identifies the distribution type for buy side orders (that is, when `side` value = `BUY`). - Orders will be rejected if the alternative investment asset does not allow the requested distribution type. - Not relevant for sell orders (that is, when `side` value = `SELL`). - Confirm the asset’s `cash_distribution_allowed` and `reinvestment_distribution_allowed` properties to know what it allows. | CASH |
| `filledQuantity` | [components.AlternativeOrderFilledQuantity](../../models/components/alternativeorderfilledquantity.md) | :heavy_minus_sign: | The actual filled share quantity of the order, which is determined after the issuer accepts the order. May differ from the requested `quantity`. | |
| `full` | *boolean* | :heavy_minus_sign: | Indicates whether this order is for a full redemption (as in, all shares redeemed). - Orders can specify only one of `full`, `notional_value`, or `quantity`. - Note that the issuer may allow only partial redemption. - Not relevant to subscription orders. | |
| `identifier` | *string* | :heavy_minus_sign: | The asset identifier value, dependent on enum value set for `identifier_type`.
For example, if `identifier_type` = `ASSET_ID`, then the value for `identifier` is the `asset_id` value. | 8395 |
| `identifierType` | [components.AlternativeOrderIdentifierType](../../models/components/alternativeorderidentifiertype.md) | :heavy_minus_sign: | Identifies which parameter value is used to identify the asset in the order. The value for that parameter is used in the `identifier` field. | ASSET_ID |
| `name` | *string* | :heavy_minus_sign: | The system-generated resource name of the alternative investment order.
Format: accounts/{account}/alternativeOrders/{alternative_order}
Note that `{account}` will be the `account_id` value and `{alternative_order}` will be the `alternative_order_id` value. | accounts/01JR8YQT40WAQT8S95ZQGS1QN0/alternativeOrders/01H5TSDAD9MQ98B8KF36J3Q8P9 |
| `notionalValue` | [components.AlternativeOrderNotionalValue](../../models/components/alternativeordernotionalvalue.md) | :heavy_minus_sign: | The requested notional value for the order. - Orders can specify only one of `full`, `notional_value`, or `quantity`. - The value must be positive. - Values are scaled to two decimal places. - Note that the issuer may allow only an order for less than the requested amount. | {
"value": "999.99"
} |
| `orderStatus` | [components.AlternativeOrderOrderStatus](../../models/components/alternativeorderorderstatus.md) | :heavy_minus_sign: | The order’s status at the time of the response. | RECEIVED |
| `quantity` | [components.AlternativeOrderQuantity](../../models/components/alternativeorderquantity.md) | :heavy_minus_sign: | The requested quantity of shares for the order. - Orders can specify only one of `full`, `notional_value`, or `quantity`. - Only relevant to redemption orders. - The value must be positive. - Note that the issuer may allow only an order for less than the requested quantity. | |
| `settlementDate` | [components.SettlementDate](../../models/components/settlementdate.md) | :heavy_minus_sign: | The date the order will be/was settled. Value will be `null` until the issuer sets a settlement date. | |
| `side` | [components.AlternativeOrderSide](../../models/components/alternativeorderside.md) | :heavy_minus_sign: | The side of the order. | BUY |
| `statusMessage` | *string* | :heavy_minus_sign: | A system-generated, user-friendly message about the order’s status. | |
| `updateTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the order was last updated. Uses [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). | 2023-10-01T12:00:00Z |