Entity description
Access to a capability/feature that can be granted to a staff member.
Properties
| Name | Description | Type | Example |
|---|---|---|---|
| unique_code | The unique identifier of the Permission | string | payments.invoices.export |
| name | The name of the permission shown to the user in the business's language | string | Export Invoices |
| description | The description of the permission shown to the user in the business's language | string | Can export invoices |
| position | The display position of the permission in the list of permissions | integer | 1 |
| is_changable | A flag to indicate if the permission, can be changed by the staff after a role was assigned. By default, permissions are editable, but some permissions like business_management.admin_account.manage cannot be changed after being assigned. Any attempt to change it in the business role or the permissions override will result in a returned error | boolean | true |
| created_at | Date the Permission was created | string | 2021-07-20T14:00:00.000Z |
| updated_at | Date the Permission was last updated | string | 2021-07-20T14:00:00.000Z |
Example
{
"unique_code": "payments.invoices.export",
"name": "Export Invoices",
"description": "Can export invoices",
"position": 1,
"is_changable": true,
"created_at": "2021-07-20T14:00:00.000Z",
"updated_at": "2021-07-20T14:00:00.000Z"
}