# Restriction

An account restriction.

## Example Usage

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

let value: Restriction = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                   | Type                                                                                                                                                                                                                                                                                                    | Required                                                                                                                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                             | Example                                                                                                                                                                                                                                                                                                 |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `active`                                                                                                                                                                                                                                                                                                | *boolean*                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | Indicates whether the restriction is active or not.                                                                                                                                                                                                                                                     | true                                                                                                                                                                                                                                                                                                    |
| `createReason`                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The plain-text reason set by a person or system explaining why the restriction was set                                                                                                                                                                                                                  | Some reason for creating                                                                                                                                                                                                                                                                                |
| `createTime`                                                                                                                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The datetime of the object's creation                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                         |
| `createUserId`                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The user attributed to the restriction's placement on the account; typically expressed as an Auth user ID                                                                                                                                                                                               | e6716139-da77-46d1-9e1b-59328e72467b                                                                                                                                                                                                                                                                    |
| `endedReason`                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The plain-text reason set by a person or system explaining why the restriction was removed If the restriction is active, the reason will not be set.                                                                                                                                                    | Some reason for removing                                                                                                                                                                                                                                                                                |
| `endedTime`                                                                                                                                                                                                                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The datetime of a restriction's removal from an account If the restriction is active, the ended time will not be set.                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                         |
| `endedUserId`                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | The user attributed to the restriction's removal from the account; typically expressed as an Auth user ID If the restriction is active, the user will not be set.                                                                                                                                       | e6716139-da77-46d1-9e1b-59328e72467b                                                                                                                                                                                                                                                                    |
| `restrictionCode`                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                      | A enumerated value indicating the nature of a restriction; prefixed by the concerned department (e.g., `MARGIN_CALL_VIOLATION_REG_T`); suspends related entitlements of the account until it is removed; most codes are administrated by the custodian but some are available for use by the integrator | MARGIN_CALL_VIOLATION_REG_T                                                                                                                                                                                                                                                                             |