> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/core/cuxial-banking/commands.md).

# Commands & permissions

The staff command of Cuxial Banking, the usable items and who can do what.

Cuxial Banking has one command, for staff. Players use the bank through branches, ATMs and items.

## Commands

| Command      | Who   | What it does                                                                                 |
| ------------ | ----- | -------------------------------------------------------------------------------------------- |
| `/bankadmin` | Staff | Opens the staff panel: overview, citizens, societies, loans, points, settings and audit log. |

The name of the command is `commands.admin.name` in `shared/config.lua`. An empty name removes the command.

## Keys

The bank adds no key bindings.

## Interactions

| Where                                   | Who                                     | What it does                             |
| --------------------------------------- | --------------------------------------- | ---------------------------------------- |
| Bank branch (target or NPC)             | Everyone, or the jobs set on that point | Opens the bank.                          |
| ATM prop or ATM point                   | Anyone carrying an active card          | Opens the ATM after the PIN.             |
| Nearby player, with the chequebook open | Bosses                                  | Issues a business cheque to that player. |

## Usable items

| Item              | Who              | What it does                                                                                    |
| ----------------- | ---------------- | ----------------------------------------------------------------------------------------------- |
| `bank_cheque`     | Whoever holds it | Shows the cheque on screen.                                                                     |
| `bank_chequebook` | Bosses of a job  | Opens the chequebook for a few seconds to issue a business cheque. Using it again puts it away. |
| `printerdocument` | Whoever holds it | Shows the printed receipt on screen.                                                            |

The names are the defaults of `data/cheques.lua` and `data/accounts.lua`.

## Permissions

### Staff

A player is bank staff when your framework grants them the permission in `admin.permission`, `'admin'` by default. The bank asks the framework through `cuxial_bridge`; it does not read ACE groups directly.

{% tabs %}
{% tab title="QBox / QBCore" %}
The player needs the `admin` permission of the framework.
{% endtab %}

{% tab title="ESX" %}
The player needs the group `admin` or `superadmin`.
{% endtab %}
{% endtabs %}

Every action of the panel checks the permission again on the server and is written to the audit log.

To also restrict the command by ACE, set a group:

{% code title="shared/config.lua" %}

```lua
commands = {
    admin = { name = 'bankadmin', restricted = 'group.admin' },
},
```

{% endcode %}

{% hint style="info" %}
With `restricted = false`, the default, anyone can type the command, and those without the staff permission get a refusal.
{% endhint %}

### Players

| Feature           | Requirement                                                                                             |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| Personal account  | Be at a branch.                                                                                         |
| Business account  | Be a boss of the job.                                                                                   |
| Shared account    | Be the owner, or a member with the permission for that operation: deposit, withdraw, transfer or loans. |
| ATM               | Carry an active card and know its PIN.                                                                  |
| Business cheque   | Be a boss of the job and carry the chequebook.                                                          |
| Job-limited point | Have one of the jobs set on that point.                                                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/core/cuxial-banking/commands.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.