esx_billing

esx_billing adds invoices to ESX Legacy. Job resources such as esx_policejob, esx_taxijob and esx_mechanicjob use it to fine or bill players. Players open their unpaid bills with F7 and pay them from cash or bank, and the money goes to the society account of the issuing job.

OverviewCopy Anchor Link

InstallationCopy Anchor Link

ensure es_extended
ensure esx_addonaccount
ensure esx_billing

ConfigurationCopy Anchor Link

All keys live in config.lua.

The daily total is kept in memory per sender identifier and calendar day, so it resets on a resource restart.

How payments workCopy Anchor Link

1. The player selects a bill in the F7 menu.
2. The server takes the money from money (cash) if the player has enough, otherwise from bank.
3. Society bills (target_type = 'society') credit the shared account named in the bill.
4. Player bills (target_type = 'player') credit the sender's same account type. The sender must be online, otherwise the payment is refused.
5. The bill is moved to billing_payments in a transaction and marked applied once both players and the account are saved. Failed credits are rolled back.

Server eventsCopy Anchor Link

esx_billing:sendBillCopy Anchor Link

TriggerServerEvent('esx_billing:sendBill', targetId, sharedAccountName, label, amount)

local player, distance = ESX.Game.GetClosestPlayer()

if player ~= -1 and distance <= 3.0 then
    TriggerServerEvent('esx_billing:sendBill', GetPlayerServerId(player), 'society_mechanic', 'Engine repair', 750)
else
    ESX.ShowNotification('No player nearby')
end

esx_billing:sendBillToIdentifierCopy Anchor Link

Local server event (not networked). It only runs when triggered by another resource and bills an identifier with sender server.

TriggerEvent('esx_billing:sendBillToIdentifier', targetIdentifier, sharedAccountName, label, amount)

Use it with a society account. A non-society bill with sender server can never be paid, because player bills require the sender to be online.

esx_billing:paidBillCopy Anchor Link

Fired after a bill was paid.

AddEventHandler('esx_billing:paidBill', function(playerId, billId)
    print(('Player %s paid bill #%s'):format(playerId, billId))
end)

Server exportsCopy Anchor Link

BillPlayerCopy Anchor Link

exports.esx_billing:BillPlayer(targetId, senderIdentifier, sharedAccountName, label, amount)

Returns the inserted bill id, or false. The export skips the job, grade, distance and confirmation checks of the net event, but still counts toward the daily quota.

local xTarget = ESX.GetPlayerFromId(targetId)
local xSender = ESX.GetPlayerFromId(source)

local billId = exports.esx_billing:BillPlayer(xTarget.source, xSender.identifier, 'society_police', 'Speeding', 500)

BillPlayerByIdentifierCopy Anchor Link

exports.esx_billing:BillPlayerByIdentifier(targetIdentifier, senderIdentifier, sharedAccountName, label, amount)

Same as BillPlayer, but targets an identifier, so the player can be offline. Returns the bill id or false.

CallbacksCopy Anchor Link

Registered with xLib.callback.registerCompat, so they work with ESX.TriggerServerCallback and xLib.callback.

ESX.TriggerServerCallback('esx_billing:getTargetBills', function(bills)
    for _, bill in ipairs(bills) do
        print(bill.label, bill.amount)
    end
end, GetPlayerServerId(closestPlayer))

Console commandCopy Anchor Link

billingpayments works only from the server console and helps with stuck payments:

billingpayments list
billingpayments show <operation_id>
billingpayments retry <operation_id>

list prints up to 20 receipts still in state claimed.

Common issuesCopy Anchor Link

• Bills never arrive: check the sender's job grade against Config.MinimumBillingGrade, the distance and that sharedAccountName is exactly society_<job>. Failed authorization prints attempted to send an unauthorized bill in the console.
• "Attempted to send bill from invalid society": the society_<job> row is missing in addon_account.
• Paying a player bill fails: the original sender is offline.
• Large fines need an extra click: bills of Config.HighBillConfirmationAmount or more open a confirmation menu on the target.

RelatedCopy Anchor Link

• esx_addonaccount
• esx_society
• esx_policejob
• Server callbacks guide
• Create a job

Frequently asked questions