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

# Installation

Page dedicated to how to install our Banking \[V2]

## Step #1 - Drag & Drop

Just Drag & Drop the `qf_banking_v2` folder into your `resources` folder.

{% hint style="warning" %}
Keep the folder name **`qf_banking_v2`**. It is used for events, NUI paths, exports and table names, so renaming the folder breaks the resource.
{% endhint %}

If you ran our Banking V1 (`qf_banking`) or Billing System (`qf_billing`), remove their `ensure` lines. Banking V2 provides both resources, so scripts that depend on them keep working. See [Moving from V1 and qf\_billing](https://wiki.qfdevelopers.com/scripts/banking-v2/additional-informations.md#moving-from-v1-and-qf_billing).

## Step #2 - SQL Installation

{% hint style="info" %}
There’s no need to manually insert any SQL file into your database. On every start the script creates the tables it needs, checks every table and column and adds whatever is missing. Updates only ever add, so restarting or updating the resource never drops your data.
{% endhint %}

On the first start the state bank and eight default branches are placed (Legion Square, Pacific Standard, Route 68, Burton, Hawick, Paleto Bay, Great Ocean Highway and Del Perro), together with a bank exchange and a management office for every bank with branches. Move or remove them later in the admin panel.

## Step #3 - Items

Ready-to-paste item definitions are in the `install/` folder of the resource:

| Inventory                                | File                        | Where to paste it               |
| ---------------------------------------- | --------------------------- | ------------------------------- |
| ox\_inventory                            | `ox_inventory_items.md`     | `ox_inventory/data/items.lua`   |
| qb-inventory, ps-inventory, lj-inventory | `qb_qs_inventory_items.txt` | `qb-core/shared/items.lua`      |
| qs-inventory                             | `qb_qs_inventory_items.txt` | `qs-inventory/config/items.lua` |
| ESX default inventory                    | `esx_items.sql`             | Run once on your database       |

`ox_inventory_items.md` holds only the definitions, so the whole file can be pasted as it is. `ox_inventory_items.txt` is the same list with comments.

```lua
['bank_card'] = {
    label = 'Bank card',
    weight = 10,
    stack = false,
    close = true,
    consume = 0,
    description = 'Payment card',
    client = { image = 'bank_card.png' },
},
-- ... the other items from install/ox_inventory_items.md
```

The item images (256 x 256 png, named after the item) are in `install/images/`. Copy them to your inventory's image folder:

* ox\_inventory: `ox_inventory/web/images/`
* qb-inventory, ps-inventory, lj-inventory: `html/images/`
* qs-inventory: `qs-inventory/html/images/`

| Item              | Label              | What it is                                                   |
| ----------------- | ------------------ | ------------------------------------------------------------ |
| `bank_card`       | Bank card          | Payment card used at ATMs, with a PIN                        |
| `checkbook`       | Checkbook          | Writes cheques                                               |
| `cheque`          | Cheque             | Cashed at a bank                                             |
| `atm_cassette`    | ATM cassette       | Cash packed by staff to refill an ATM                        |
| `bank_statement`  | Bank statement     | Printed account statement                                    |
| `bank_contract`   | Contract           | Copy of a signed bank contract                               |
| `deposit_box_key` | Deposit box key    | Opens a deposit box                                          |
| `bank_tablet`     | Bank tablet        | Opens the bank management tablet anywhere                    |
| `bank_loot_bag`   | Convoy loot bag    | Cash taken from a robbed convoy                              |
| `ticket_book`     | Ticket book        | Issues fines and invoices for your faction                   |
| `billing_tablet`  | Billing tablet     | Your bills, fines and contracts                              |
| `sale_contract`   | Sale contract form | Blank contract to sell a vehicle, property or items (stacks) |
| `vehicle_title`   | Vehicle title      | Proof of who owns a vehicle                                  |
| `bank_receipt`    | ATM receipt        | Printed by an ATM after an operation                         |
| `bank_bill`       | Bill               | A fine or an invoice on paper                                |

{% hint style="info" %}
On qb-inventory and qs-inventory the items are `unique = true` and `useable = true` (`sale_contract` is `unique = false`). Different item names can be set in **Admin → Items**; rename the images to match. Items that are missing from your inventory are listed in the console on start and marked in **Admin → Items**.
{% endhint %}

{% hint style="warning" %}
Cheques, cassettes, cards and papers carry item metadata. The ESX default inventory keeps no metadata, so with it ATMs offer the player's cards from the bank instead of a card item, and robbery loot is paid at once instead of in a bag.
{% endhint %}

## Step #4 - Script start

Make sure `oxmysql`, your framework and your inventory start before Banking V2:

```
ensure oxmysql
ensure es_extended        # or qb-core / qbx_core
ensure ox_inventory       # your inventory
ensure qf_banking_v2
```

On start the console prints the framework, inventory and target it found. A framework or inventory started after Banking V2 is still found, with a console warning to fix the order.

## Step #5 - Admin access

The admin panel opens with `/bankadmin` for the groups `superadmin`, `admin` and `god`, or for anyone with the ace below. Add it to your `server.cfg` if you use aces:

```
add_ace group.admin qf_banking.admin allow
```

Then join the server, run `/bankadmin` and go through **General**, **Banks**, **Branches**, **ATMs** and **Items**. Every other module can be given to other groups in **Admin → Permissions**.

## Requirements

* ESX (Legacy, older ESX through the `esx:getSharedObject` event), QBCore or QBox, detected automatically
* `oxmysql`
* OneSync (server-side distance checks read player positions)

Optional:

* ox\_inventory, qb-inventory (1.x or 2.x), ps-inventory, lj-inventory, qs-inventory or the ESX default inventory. Other inventories are connected through `bridge/inventory.server.lua` (see [Configuration](https://wiki.qfdevelopers.com/scripts/banking-v2/configuration.md#framework-inventory-and-target)).
* `ox_target`, `qb-target` or `qtarget`. Without one, players use a marker and the interaction key (E by default, rebindable in Settings → Key Bindings → FiveM).
* `ox_lib`, `okokNotify` or `mythic_notify` for notifications and help text, when you do not use the built-in QF notifications.
* `qf_identity` for character photos everywhere in the interface.
* A vehicle key script for the convoy van: qbx\_vehiclekeys, qb-vehiclekeys, Renewed-Vehiclekeys, MrNewbVehicleKeys, wasabi\_carlock, qs-vehiclekeys, Jaksam's vehicles\_keys, mk\_vehiclekeys, t1ger\_keys, cd\_garage, okokGarage or your own.
* A society money resource for billing: `esx_addonaccount` (ESX), `qb-banking` 2.x or `qb-management` (QBCore), `Renewed-Banking` (QBox). Not needed when billing is off.
* Our [Police](https://wiki.qfdevelopers.com/scripts/editor-4.md), [Ambulance](https://wiki.qfdevelopers.com/scripts/editor-5.md), [Mechanic](https://wiki.qfdevelopers.com/scripts/editor-22.md) and [DOJ](https://wiki.qfdevelopers.com/scripts/editor-22-1.md) MDT \[V2] for fines and invoices issued from the tablets.

{% hint style="info" %}
vRP, which V1 supported, is no longer supported.
{% endhint %}


---

# 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://wiki.qfdevelopers.com/scripts/banking-v2/installation.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.
