Admin Commands

Every oxide-banking admin command — player and job accounts, loans and credit, the banking schedule, failed refunds, debugging — and how to grant admin access.

Admin and utility commands for oxide-banking.

Who Can Use These

Every admin command checks that you are a server admin. You pass that check if you have either of these permissions. They are FiveM "ACE" permissions, which you set in your server.cfg (the text file that controls your server):

  • command — stock QBCore and QBX server.cfg files already give this to the group.admin group
  • admin

On ESX, anyone ESX already treats as an admin also passes.

The server console can run every admin command as well.

If you need to add it

If a command tells you that you do not have permission, add these two lines to your server.cfg, then restart the server:

server.cfg
add_principal identifier.license:YOUR_LICENSE group.admin
add_ace       group.admin                     admin allow

The first line puts you in the admin group. The second gives that group the admin permission. Replace YOUR_LICENSE with your FiveM license identifier.

In the tables below, <citizenid> means the player's character ID from your framework (the citizen ID on QBCore and QBX, the character identifier on ESX), not their server ID.

Player Account Commands

CommandWhat it does
/freezeaccount <citizenid> [reason]Freeze a player's bank account. They cannot open the bank or use ATMs, and nobody can transfer money to them. The reason is optional
/unfreezeaccount <citizenid>Remove the freeze
/setcreditscore <citizenid> <score>Move a player's credit score toward a value between 300 and 850 (see the note below)
/viewplayeraccounts <citizenid>Print a player's cash, bank, tier, shared accounts and job account in the server console

About /setcreditscore. The change is added to the player's score as a credit adjustment, the same way an on-time payment or a missed payment is. Two things follow from that:

  • The adjustment can only move the score up to Config.CreditScore.maxEventBonus points (150 by default) away from the score the bank calculates for the player. Asking for more than that stops at the limit.
  • The adjustment fades a little every banking day, like every other credit event, so the score drifts back toward the calculated score over time.

See Credit Score for how the score is built.

Job Account Commands

CommandWhat it does
/addjobmoney <account> <amount> [reason]Add money to a job account (e.g. police)
/removejobmoney <account> <amount> [reason]Remove money from a job account. Refused if the account does not hold that much
/setjobmoney <account> <amount>Set a job account's balance exactly
/viewjobaccount <account>Show a job account's type and balance. More detail is printed in the server console
/listjobaccountsPrint every job account and its balance in the server console

ESX servers: avoid /setjobmoney

/setjobmoney only changes the bank's own copy of a society balance. When banking starts again, it reloads the balance from esx_addonaccount and the change is lost. Use /addjobmoney and /removejobmoney on ESX instead — those two go through esx_addonaccount.

Loan And Credit Commands

CommandWhat it does
/pendingloansList loans waiting for admin approval in the server console
/approveloan <loanId>Approve a waiting loan and pay the money to the borrower
/denyloan <loanId> [reason]Deny a waiting loan. The reason is optional and is shown to the player if they are online
/recalculatecredit [citizenid]Recalculate a player's credit score from scratch. Leave the ID out to recalculate your own
/forceinquirydecayRun the daily clean-up of old credit inquiries now

Which applications wait for approval is set in Config.LoanApproval — see Approval, late fees, and collections.

Schedule Commands

Banking runs interest, loan payments, and other tasks on its own daily schedule (see Scheduling And Time). These commands let you check on it or run a task right now instead of waiting:

CommandWhat it does
/schedulerstatusShow the current banking day, the server time, and the last day the daily tasks ran for
/forcedayincrementAdd one banking day and run all daily tasks
/forceinterestPay savings interest now to any savings account not yet paid for the current banking day
/forceloanpaymentsCollect loan instalments that are due today or earlier
/forceinvoicesMark overdue invoices and bring their late fees up to date
/forceinvoices collectThe same, and also collect what is owed from debtors' accounts. This collects even if InvoiceAutoDebitEnabled = false
/forcemarketupdateRun one extra market day now, which moves investment values
/forcerecurringProcess recurring payments that are due
/forcedividendsPay any investment dividends that are due
/forcecardcleanupDelete cancelled and revoked card records older than Config.Cards.CancelledCardRetentionDays

Good to know:

  • Loan due dates and invoice due dates follow the real calendar. /forcedayincrement does not make them fall due early.
  • /forceinterest right after the automatic daily run pays nothing, because every account has already been paid for that day.

Failed Refunds

When a transfer, recurring payment or bill payment cannot be delivered, the bank refunds the payer. If that refund also fails, the money is owed to the player and has to be put back by hand:

  • Every admin online gets a notification naming the player, the amount and the payment.

  • The bank writes it to the bank_audit_log table with the action refund_failed. To list them, run:

    SELECT * FROM bank_audit_log WHERE action = 'refund_failed' ORDER BY timestamp DESC;
  • The player is told the money did not come back and that an admin has been alerted.

Pay the amount back with your framework's own admin money command, then check the player's balance.

Debugging

CommandWhat it does
/bankingdebugToggle extra banking output in the server console

/bankingdebug only works if Config.DebugSettings.AllowInProduction = true. Debug output can include player details, so leave it off on a live server and turn it on only while troubleshooting. It turns itself off after Config.DebugSettings.AutoTimeoutMinutes (30 by default).

Player Utility Command

CommandWhat it doesWho can use it
/givecash <id> <amount>Hand cash to another player standing within 5 meters. <id> is their server IDEveryone (it gives the player's own cash, not free money)

Every banking command shows chat suggestions, and its help text and chat replies can be translated in locales/en.json — see Localization.