Exports

💰 Money Management

AddBankMoney

Add money to a player's bank account with automatic transaction logging.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
amount	number	✅	Amount to add to bank account
description	string	❌	Custom transaction description

Returns: boolean - Success status

Example

-- Add salary payment
local success = exports['omes_banking']:AddBankMoney(1, 5000, "Weekly salary")
if success then
    TriggerClientEvent('esx:showNotification', 1, 'Salary deposited!')
end

Job Integration

---

RemoveBankMoney

Remove money from a player's bank account with balance validation.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
amount	number	✅	Amount to remove from bank
description	string	❌	Custom transaction description

Returns: boolean - Success status (false if insufficient funds)

Example

-- Process fine payment
if exports['omes_banking']:RemoveBankMoney(1, 1500, "Speeding fine") then
    -- Fine paid successfully
else
    -- Insufficient funds
end

Shop Purchase

---

AddCashMoney

Add cash directly to player's inventory.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
amount	number	✅	Cash amount to add
description	string	❌	Transaction description

Returns: boolean - Success status

-- Give cash reward
exports['omes_banking']:AddCashMoney(1, 500, "Tip from customer")

---

RemoveCashMoney

Remove cash from player's inventory with validation.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
amount	number	✅	Cash amount to remove
description	string	❌	Transaction description

Returns: boolean - Success status (false if insufficient cash)

---

📊 Account Information

GetPlayerAccount

Retrieve complete player account information.

server.lua

local account = exports['omes_banking']:GetPlayerAccount(source)

Returns: table or nil - Account data object

Return Structure

{
    source = 1,
    name = "John Doe",
    identifier = "license:abc123",
    bankBalance = 15000,
    cashBalance = 500,
    accountNumber = "****-****-c123"
}

local account = exports['omes_banking']:GetPlayerAccount(1)
if account then
    print("Player: " .. account.name)
    print("Bank: $" .. account.bankBalance)
    print("Cash: $" .. account.cashBalance)
end

---

GetBankBalance

Get player's current bank balance.

server.lua

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

Returns: number - Bank balance (0 if player not found)

---

GetCashBalance

Get player's current cash balance.

server.lua

local cash = exports['omes_banking']:GetCashBalance(source)

Returns: number - Cash balance (0 if player not found)

---

💸 Transfers & Validation

TransferMoney

Transfer money between two players' bank accounts.

server.lua

local success = exports['omes_banking']:TransferMoney(fromSource, toSource, amount, description)

Parameter	Type	Required	Description
fromSource	number	✅	Sender's server ID
toSource	number	✅	Recipient's server ID
amount	number	✅	Transfer amount
description	string	❌	Transfer description

Returns: boolean - Success status

Transfer Validation:

• Checks if both players exist

• Validates sender has sufficient funds

• Prevents self-transfers

• Logs transactions for both parties

---

HasEnoughBank

Check if player has sufficient bank funds.

server.lua

local hasEnough = exports['omes_banking']:HasEnoughBank(source, amount)

Returns: boolean - True if sufficient funds available

-- Always check before removing money
if exports['omes_banking']:HasEnoughBank(playerId, cost) then
    exports['omes_banking']:RemoveBankMoney(playerId, cost, "Purchase")
    -- Process purchase
else
    -- Handle insufficient funds
end

---

HasEnoughCash

Check if player has sufficient cash.

server.lua

local hasEnough = exports['omes_banking']:HasEnoughCash(source, amount)

Returns: boolean - True if sufficient cash available

---

🏦 Savings Accounts

Note: Savings account exports only work when Config.Banking.allowSavingsAccounts = true

GetSavingsAccount

Retrieve player's savings account information.

server.lua

exports['omes_banking']:GetSavingsAccount(source, callback)

Parameter	Type	Required	Description
source	number	✅	Player's server ID
callback	function	✅	Callback to receive result

exports['omes_banking']:GetSavingsAccount(1, function(savingsData)
    if savingsData then
        print("Savings Balance: $" .. savingsData.balance)
        print("Status: " .. savingsData.status)
        print("Active: " .. tostring(savingsData.active))
    else
        print("No savings account found")
    end
end)

---

AddSavingsMoney

Add money to player's savings account.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
amount	number	✅	Amount to add to savings
description	string	❌	Transaction description

Returns: boolean - Success status

---

🔧 Utility Functions

LogCustomTransaction

Log custom transactions in player's banking history.

server.lua

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

Parameter	Type	Required	Description
source	number	✅	Player's server ID
type	string	✅	Transaction type
amount	number	✅	Transaction amount
description	string	✅	Detailed description

-- Log mission completion
exports['omes_banking']:LogCustomTransaction(1, "mission", 1500, "Completed delivery #123")

---

OpenBankingUI

Open the banking interface for a player.

server.lua

local success = exports['omes_banking']:OpenBankingUI(source)

Returns: boolean - Success status

---

🚀 Integration Examples

Job System Integration

Job Script Example

-- Job completion handler
RegisterNetEvent('job:complete')
AddEventHandler('job:complete', function(jobData)
    local src = source
    local payment = jobData.payment
    local jobName = jobData.name
    
    -- Pay player
    if exports['omes_banking']:AddBankMoney(src, payment, "Job: " .. jobName) then
        TriggerClientEvent('esx:showNotification', src, 
            'Job completed! $' .. payment .. ' deposited.')
        
        -- Log custom transaction
        exports['omes_banking']:LogCustomTransaction(src, 
            'job_completion', payment, jobName .. ' completed successfully')
    end
end)

---

Shop System Integration

Shop Script Example

-- Purchase processor
function ProcessPurchase(buyerId, item, cost)
    -- Validate funds
    if not exports['omes_banking']:HasEnoughBank(buyerId, cost) then
        TriggerClientEvent('esx:showNotification', buyerId, 'Insufficient funds')
        return false
    end
    
    -- Process payment
    if exports['omes_banking']:RemoveBankMoney(buyerId, cost, "Purchased: " .. item.name) then
        -- Give item to player
        GiveItem(buyerId, item)
        
        TriggerClientEvent('esx:showNotification', buyerId, 
            'Purchased ' .. item.name .. ' for $' .. cost)
        return true
    end
    
    return false
end

---

Admin Commands Integration

Admin Commands Example

-- Give money command
RegisterCommand('givemoney', function(source, args)
    if IsPlayerAceAllowed(source, 'admin') then
        local targetId = tonumber(args[1])
        local amount = tonumber(args[2])
        local reason = table.concat(args, ' ', 3) or 'Admin grant'
        
        if targetId and amount then
            if exports['omes_banking']:AddBankMoney(targetId, amount, reason) then
                TriggerClientEvent('chat:addMessage', source, {
                    args = {"ADMIN", "Added $" .. amount .. " to player " .. targetId}
                })
            end
        end
    end
end, false)

-- Remove money command
RegisterCommand('removemoney', function(source, args)
    if IsPlayerAceAllowed(source, 'admin') then
        local targetId = tonumber(args[1])
        local amount = tonumber(args[2])
        local reason = table.concat(args, ' ', 3) or 'Admin removal'
        
        if targetId and amount then
            if exports['omes_banking']:RemoveBankMoney(targetId, amount, reason) then
                TriggerClientEvent('chat:addMessage', source, {
                    args = {"ADMIN", "Removed $" .. amount .. " from player " .. targetId}
                })
            end
        end
    end
end, false)

---

⚠️ Error Handling

All exports include comprehensive error handling:

✅ Automatic Validation:

• Player existence checks

• Parameter validation

• Balance verification

• Framework compatibility

📝 Logging Features:

• Console error messages

• Transaction history logging

• Discord webhook notifications

• Detailed operation tracking

🛡️ Safety Features:

• Prevents negative amounts

• Validates player objects

• Checks sufficient funds

• Framework-agnostic design

---

Resource Name: omes_banking

Version: Latest

Framework Support: ESX & QB-Core