Documentation
This section lists all available commands and exports included in the script. You'll find client-side and server-side functions designed to help developers integrate, extend, or interact with billing from their own scripts.
Quasar Billing registers two in-game commands and three console commands. The in-game ones respect permissions; the console ones exist for the cases where you cannot get into the game to fix something.
Command | Where | Description |
|---|---|---|
| In game | Opens the interface. Bound to |
/billingadminIn game |
Reopens the admin access screen once the server already has an admin. It grants nothing by itself. |
| Console | Reports which of the four access routes is shut for that player, and why. Run this before opening a ticket. |
| Console | Grants in-game admin access to a connected player. |
| Console | Drops this resource's tables, re-runs migrations and re-seeds. Debug mode only. |
dbresetdeletes every invoice, payment and setting belonging to billing, and there is no undo. It refuses to run with debug off, precisely so it can never fire on a live server. It touches no other resource's data.
Sixteen server exports. These are how another resource drives billing — a fine from your MDT, a fee from your garage, a rent charge from your housing script, or a check on whether somebody owes money before you let them collect a car.
local reference, err = exports['qs-billing']:CreateInvoice({
target = source, -- server id, OR an identifier string for an offline player
society = 'police', -- omit for a private invoice, billed by a person
category = 'fine',
lines = {
{ label = 'Speeding', price = 500, quantity = 1 },
{ label = 'No insurance', price = 250 },
},
dueHours = 72,
notes = 'Highway 1, radar 4',
metadata = { mdtFineId = 812 },
})
if not reference then
print('billing refused it:', err) -- err is a locale key, e.g. error.no_lines
endThe export most integrations need. It returns the invoice reference string, or nil plus an error key when the server refuses it.
Field | What it does |
|---|---|
| Who pays. A server id for an online player, or an identifier string to bill somebody offline. |
| At least one. Each takes |
|
Lines are re-priced on the server, so a total you send is ignored. Invoices made this way also skip the approval queue — an integration is not an employee, so it is not held against a grade's limit.
-- In your garage, before handing a car back:
if exports['qs-billing']:IsServiceBlocked(identifier, 'garage') then
return Notify(source, 'Unpaid fines. Settle them before collecting a vehicle.')
end
-- Or the blunt version, for anything overdue at all:
if exports['qs-billing']:HasOverdue(identifier) then ... endBoth return a boolean. IsServiceBlocked answers for a named service; the names are free text, and whatever you typed into a collection stage is what you check for here.
Nothing enforces itself. Billing keeps the list — your resource decides what being blocked means. Add housing to a stage and never ask about it, and nothing happens to anybody's house.
local owed = exports['qs-billing']:GetOutstandingTotal(identifier) --> number
-- Make a consequence proportional instead of binary
if owed > 5000 then
ApplyCreditFreeze(identifier)
endReturns everything still owed by that identifier across pending, partial and overdue invoices, as a plain number. Useful when you want a threshold rather than a yes or no.
-- One invoice, lines included
local invoice = exports['qs-billing']:GetInvoice('INV-4K7P92')
-- A player's invoices; scope defaults to 'received'
local list = exports['qs-billing']:GetPlayerInvoices(identifier, {
scope = 'received',
status = 'overdue',
})Read-only lookups. GetInvoice takes a reference and returns the whole invoice with its line items; GetPlayerInvoices takes an identifier and an optional filter table.
-- Charge a player for an invoice. account is 'bank' or 'cash'
exports['qs-billing']:PayInvoice(payerSource, reference, 'bank')
-- Withdraw an invoice. Any partial payment is refunded
exports['qs-billing']:CancelInvoice(reference, 'Issued in error')
-- Pay a settled invoice back in full, from the company account
exports['qs-billing']:RefundInvoice(source, reference, 'Goodwill')The three write operations on an existing invoice. RefundInvoice only works on invoices that were paid in full, and the company account has to be able to cover it.
local id, err = exports['qs-billing']:CreateRecurring({
label = 'Apartment 4B rent',
society = 'realestate',
targetIdentifier = identifier,
intervalHours = 168, -- weekly. 1 to 8760
occurrences = -1, -- -1 runs until stopped; max 1000
dueHours = 48,
lines = { { label = 'Weekly rent', unitPrice = 1500, quantity = 1 } },
})Creates a template that issues a fresh invoice on a schedule — rent, insurance, a retainer. Returns the schedule id, or nil plus an error key.
exports['qs-billing']:IsAdmin(source) --> boolean, across all four routes
exports['qs-billing']:CanIssue(source) --> may that job and grade bill at all
exports['qs-billing']:CanPlayerBill(source) --> the fuller check the UI itself usesThree levels of the same question. CanIssue asks only about the job and grade; CanPlayerBill is what the interface uses, and also weighs duty status and the feature switches.
-- Any live setting, by dotted path
local hours = exports['qs-billing']:GetSetting('billing.dueHours', 72)
-- The bridge table billing talks to your framework through
local Framework = exports['qs-billing']:GetFramework()Because settings live in the database and change without a restart, GetSetting always returns the current value — do not cache it on your side.
exports['qs-billing']:Notify(source, {
type = 'success',
title = 'Invoice paid',
description = 'INV-4K7P92 has been settled.',
})Sends a notification through whatever notification system the server is running, so your message looks like every other message on the server rather than like billing's.
Eight client exports, for opening the interface from your own scripts — a laptop prop, a phone app, a radial menu entry.
exports['qs-billing']:OpenUi()
exports['qs-billing']:CloseUi()
exports['qs-billing']:ToggleUi()
exports['qs-billing']:IsUiOpen() --> booleanThe four ways to control the window. IsUiOpen is worth checking before you open something of your own over the top of it.
exports['qs-billing']:OpenInvoice('INV-4K7P92')Opens the interface straight onto one document, skipping the list. Use it when your script already knows which invoice the player cares about.
local data = exports['qs-billing']:GetPlayerData()Returns billing's normalised view of the local player — identity, job, grade and duty — in the same shape on every framework. Handy if you want one code path instead of one per framework.
local locale = exports['qs-billing']:GetLocale()
--> { locale = 'es', dict = { ui = { ... }, error = { ... } } }The language the server is running, and the whole dictionary behind it — already merged over English, so every key is present whatever the translation left out. This is how the phone app puts every string in the player's language without shipping a second copy of the locales to fall behind the first, and it is there for your own scripts to do the same.
exports['qs-billing']:Notify({
type = 'success',
title = 'Invoice paid',
})The client-side twin of the server export. Works whether or not the interface is open — the page is always loaded, it simply has no focus.
Every export that can refuse returns a locale key, not a sentence: error.no_lines, error.amount_too_high, error.invalid_interval.
That is deliberate — it means the same failure reads in the player's own language, in all seven of them. Log the key for yourself; do not show it raw to a player.
The company it is billed for, and the account the money lands in. Omit it for a private invoice.
| Anything you want handed back when the invoice is settled. This is how an MDT closes its own fine. |
| Optional. Falls back to the server's configured default. |