# Entitlement

An Entitlement for an Account. Defines what the account is allowed to do.

## Example Usage

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

let value: Entitlement = {};
```

## Fields

| Field                                                                                                                                                | Type                                                                                                                                                 | Required                                                                                                                                             | Description                                                                                                                                          | Example                                                                                                                                              |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `displayName`                                                                                                                                        | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | A friendly name for the entitlement used primarily for UI display                                                                                    | Banking - Out                                                                                                                                        |
| `entitlementCode`                                                                                                                                    | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | The enum value of the entitlement being described; e.g., BANKING_CHECK                                                                               | BANKING_CHECK                                                                                                                                        |
| `lastModifiedReason`                                                                                                                                 | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | A system-generated reason about why the last modification occurred - typically due to an enrollment or restriction event                             | A restriction has been ended due to all party investigations meeting the necessary requirements for the associated account                           |
| `lastModifiedTime`                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                        | :heavy_minus_sign:                                                                                                                                   | The last time the underlying entitlement had its status updated                                                                                      |                                                                                                                                                      |
| `parentEntitlements`                                                                                                                                 | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | The entitlement above the subject; A model of status inheritance exists which provides context on this value                                         | [<br/>"BANKING"<br/>]                                                                                                                                |
| `state`                                                                                                                                              | [components.EntitlementState](../../models/components/entitlementstate.md)                                                                           | :heavy_minus_sign:                                                                                                                                   | GRANTED if it was activated via an enrollment, SUSPENDED if a restriction has temporarily disabled it, or DENIED if it has never before been GRANTED | GRANTED                                                                                                                                              |