# AlternativeOrderCreate

An order for an alternative investment.

## Example Usage

```typescript
import {
  AlternativeOrderCreate,
  AlternativeOrderCreateIdentifierType,
  AlternativeOrderCreateSide,
} from "@apexfintechsolutions/ascend-sdk/models/components";

let value: AlternativeOrderCreate = {
  clientOrderId: "f5074670-1b25-439f-9b5c-702027660800",
  identifier: "8395",
  identifierType: AlternativeOrderCreateIdentifierType.AssetId,
  side: AlternativeOrderCreateSide.Buy,
};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                                                                                                                                                                                 | Example                                                                                                                                                                                                                                                                                                                                                                                                     |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientOrderId`                                                                                                                                                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                          | A client-supplied unique ID to enforce idempotency. Each ID must be unique within the account.<br/><br/> 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                                                                                                                                                                                                                                                                                                                                                                        |
| `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.DistributionType](../../models/components/distributiontype.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                                                                                                                                                                                                                                                                                                                                                                                                        |
| `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.                                                                                                                                              | <nil>                                                                                                                                                                                                                                                                                                                                                                                                       |
| `identifier`                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                          | The asset identifier value, dependent on enum value set for `identifier_type`.<br/><br/> For example, if `identifier_type` = `ASSET_ID`, then the value for `identifier` is the `asset_id` value.                                                                                                                                                                                                           | 8395                                                                                                                                                                                                                                                                                                                                                                                                        |
| `identifierType`                                                                                                                                                                                                                                                                                                                                                                                            | [components.AlternativeOrderCreateIdentifierType](../../models/components/alternativeordercreateidentifiertype.md)                                                                                                                                                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                          | 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                                                                                                                                                                                                                                                                                                                                                                                                    |
| `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                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
| `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.AlternativeOrderCreateSide](../../models/components/alternativeordercreateside.md)                                                                                                                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                          | The side of the order.                                                                                                                                                                                                                                                                                                                                                                                      | BUY                                                                                                                                                                                                                                                                                                                                                                                                         |