Exports

Overview

The omes_banking script provides a comprehensive set of exports that allow other resources to interact with the banking system. These exports are split into client-side and server-side functions.

---

Client-Side Exports

These exports can be called from any client-side script.

openBank

Opens the full bank UI menu with all features (overview, transfers, savings, loans, etc.).

exports['omes_banking']:openBank()

Example:

-- Open bank from a custom NPC or location
RegisterCommand('bank', function()
    exports['omes_banking']:openBank()
end)

---

openATM

Opens the simplified ATM UI (deposit, withdraw, and recent transactions only).

exports['omes_banking']:openATM()

Example:

-- Open ATM when player interacts with a custom object
exports['omes_banking']:openATM()

---

isBankOpen

Returns whether the bank UI is currently open. Useful for preventing duplicate opens or checking UI state.

local isOpen = exports['omes_banking']:isBankOpen()

Returns: boolean - true if the bank UI is open, false otherwise.

Example:

-- Prevent opening another menu while bank is open
if not exports['omes_banking']:isBankOpen() then
    -- Open your custom menu
end

---

closeBank

Closes the bank/ATM UI if it's currently open.

exports['omes_banking']:closeBank()

Example:

-- Force close bank when player enters a vehicle
AddEventHandler('baseevents:enteredVehicle', function()
    exports['omes_banking']:closeBank()
end)

---

openLoanManager

Opens the Loan Manager UI. This is intended for bank employees and requires the configured banker job access.

exports['omes_banking']:openLoanManager()

Example:

-- Open loan manager from a custom banker interaction
exports['omes_banking']:openLoanManager()

Note: The player must have the required banker job configured in Config.BankerJobs to access this UI.

---

Server-Side Exports

These exports can be called from any server-side script.

getPlayerBalance

Gets a player's current bank balance.

local balance = exports['omes_banking']:getPlayerBalance(source)

Parameters:

Parameter	Type	Description
source	number	The player's server ID

Returns: number - The player's bank balance, or 0 if the player was not found.

Example:

-- Check if player can afford something
local balance = exports['omes_banking']:getPlayerBalance(source)
if balance >= 5000 then
    -- Player can afford the item
end

---

addMoney

Adds money to a player's bank account. Optionally logs the transaction with a description.

local success = exports['omes_banking']:addMoney(source, amount, description)

Parameters:

Parameter	Type	Description
source	number	The player's server ID
amount	number	The amount to add
description	string (optional)	Transaction description for bank logs

Returns: boolean - true if successful, false if the player was not found or the amount was invalid.

Example:

-- Pay player from a job script
RegisterCommand('paycheck', function(source)
    local success = exports['omes_banking']:addMoney(source, 1500, 'Weekly Paycheck')
    if success then
        TriggerClientEvent('ox_lib:notify', source, {
            title = 'Paycheck',
            description = 'You received $1,500',
            type = 'success'
        })
    end
end)

---

removeMoney

Removes money from a player's bank account. Returns false if the player has insufficient funds.

local success = exports['omes_banking']:removeMoney(source, amount, description)

Parameters:

Parameter	Type	Description
source	number	The player's server ID
amount	number	The amount to remove
description	string (optional)	Transaction description for bank logs

Returns: boolean - true if successful, false if the player was not found, amount was invalid, or insufficient funds.

Example:

-- Charge player for a service
local success = exports['omes_banking']:removeMoney(source, 500, 'Hospital Bill')
if success then
    -- Proceed with the service
else
    -- Notify player of insufficient funds
    TriggerClientEvent('ox_lib:notify', source, {
        title = 'Payment Failed',
        description = 'Insufficient funds in your bank account',
        type = 'error'
    })
end

---

getSavingsAccounts

Gets all savings accounts for a player by their identifier.

local accounts = exports['omes_banking']:getSavingsAccounts(identifier)

Parameters:

Parameter	Type	Description
identifier	string	The player's identifier (e.g., license:xxxxx or citizenid)

Returns: table - An array of savings account objects.

Account Object Structure:

{
    id = 1,                     -- Account ID
    accountType = 'savings',    -- Account type key
    label = 'Savings Account',  -- Display label
    balance = 5000,             -- Current balance
    interestRate = 2.5,         -- Interest rate percentage
    createdAt = '2024-01-01',   -- Creation date
    lastInterestDate = '2024-01-07' -- Last interest payout date
}

Example:

-- Get player's savings accounts
local identifier = exports['omes_banking']:getPlayerIdentifier(source)
local accounts = exports['omes_banking']:getSavingsAccounts(identifier)

local totalSavings = 0
for _, account in ipairs(accounts) do
    totalSavings = totalSavings + account.balance
end

print('Player has $' .. totalSavings .. ' in savings')

---

getPlayerIdentifier

Gets a player's identifier from their server source ID.

local identifier = exports['omes_banking']:getPlayerIdentifier(source)

Parameters:

Parameter	Type	Description
source	number	The player's server ID

Returns: string|nil - The player's identifier, or nil if the player was not found.

Example:

-- Get identifier for database queries
local identifier = exports['omes_banking']:getPlayerIdentifier(source)
if identifier then
    -- Use identifier for custom database operations
end

---

transferMoney

Transfers money between two players' bank accounts. Both sender and recipient must be online.

local success, message = exports['omes_banking']:transferMoney(fromSource, toSource, amount, reason)

Parameters:

Parameter	Type	Description
fromSource	number	The sender's server ID
toSource	number	The recipient's server ID
amount	number	The amount to transfer
reason	string (optional)	Reason for the transfer (logged in transaction history)

Returns:

• boolean - true if successful, false otherwise

• string - A message describing the result

Possible Messages:

• 'Sender not found'

• 'Recipient not found'

• 'Invalid amount'

• 'Insufficient funds'

• 'Transfer successful'

Example:

-- Transfer money between players from an admin command
RegisterCommand('transfer', function(source, args)
    local fromPlayer = tonumber(args[1])
    local toPlayer = tonumber(args[2])
    local amount = tonumber(args[3])
    
    local success, message = exports['omes_banking']:transferMoney(fromPlayer, toPlayer, amount, 'Admin Transfer')
    
    print(message)
end, true) -- Restricted to admins

---

Complete Example

Here's a complete example of a script that uses multiple exports:

-- server.lua
RegisterCommand('bankinfo', function(source)
    local identifier = exports['omes_banking']:getPlayerIdentifier(source)
    local balance = exports['omes_banking']:getPlayerBalance(source)
    local savings = exports['omes_banking']:getSavingsAccounts(identifier)
    
    local totalSavings = 0
    for _, account in ipairs(savings) do
        totalSavings = totalSavings + account.balance
    end
    
    print(string.format(
        'Player %s - Bank: $%s | Savings: $%s | Total: $%s',
        identifier,
        balance,
        totalSavings,
        balance + totalSavings
    ))
end)

-- Pay with bank fallback to insufficient funds
RegisterCommand('buy', function(source, args)
    local price = 1000
    
    local success = exports['omes_banking']:removeMoney(source, price, 'Store Purchase')
    
    if success then
        -- Give item to player
        TriggerClientEvent('ox_lib:notify', source, {
            title = 'Purchase Complete',
            description = 'You paid $' .. price .. ' from your bank',
            type = 'success'
        })
    else
        TriggerClientEvent('ox_lib:notify', source, {
            title = 'Purchase Failed',
            description = 'Not enough money in your bank',
            type = 'error'
        })
    end
end)

---

Notes

• All monetary amounts are automatically rounded down to whole numbers (math.floor)

• Transaction descriptions are optional but recommended for proper bank statement history

• The removeMoney export will not remove money if the player has insufficient funds

• Server exports require the player to be online (connected to the server)

• Client exports will only work on the client that calls them