# CancelOrderRequestCreate

The message to request cancellation of an existing order

## Example Usage

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

let value: CancelOrderRequestCreate = {
  name:
    "accounts/01HBRQ5BW6ZAY4BNWP4GWRD80X/orders/ebb0c9b5-2c74-45c9-a4ab-40596b778706",
};
```

## Fields

| Field                                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cancelInitiator`                                                                                                                                                                                                                                                                          | [components.CancelOrderRequestCreateCancelInitiator](../../models/components/cancelorderrequestcreatecancelinitiator.md)                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                         | Only relevant for CAT reporting when clients have Apex do CAT reporting on their behalf. A value may be provided for non-Equity orders, and will be remembered, but the value will have no impact on how they are processed. Cancel requests without this field set will default to CLIENT | FIRM                                                                                                                                                                                                                                                                                       |
| `clientCancelReceivedTime`                                                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                         | Related to CAT reporting when Apex reports for the client. A value may be provided for non-Equity orders, and will be remembered, but valid timestamps will have no impact on how they are processed.                                                                                      | {"seconds": 1712081516, "nanos": 902000000}                                                                                                                                                                                                                                                |
| `clientCancelSentTime`                                                                                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                         | Related to CAT reporting when Apex reports for the client. Denotes the time the client sent the cancel request to Apex. A value may be provided for non-Equity orders, and will be remembered, but valid timestamps will have no impact on how they are processed.                         | 2024-12-22T05:00:00Z                                                                                                                                                                                                                                                                       |
| `name`                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                         | Format: accounts/{account_id}/orders/{order_id}                                                                                                                                                                                                                                            | accounts/01HBRQ5BW6ZAY4BNWP4GWRD80X/orders/ebb0c9b5-2c74-45c9-a4ab-40596b778706                                                                                                                                                                                                            |