🗄️ Server exports

Common server exports for Finance 1.0.1. Call after startup, validate identity and prices server-side, and never expose money mutations as unrestricted network events.

Export	Returns
`GetSocietyAccount(society)`	Account table, or `nil`. `society` is a job/society identifier.
`GetSocietyAccountMoney(society)`	Numeric balance, or `nil`.
`GetAccountByIban(iban)`	Account table, or `nil`.
`GetAccountMoneyByIban(iban)`	Numeric balance, or `nil`.
`GetPersonalAccountByPlayerId(playerId)`	Personal account for a loaded player server ID, or `nil`.
`GetPersonalAccountByPlayerIdentifier(identifier)`	Personal account for a framework character identifier, or `nil`.
`GetXTransactionsByIban(iban, page?)`	Table with `success`, `transactions`, and `totalTransactions`. Page defaults to `0`.

Pass IBANs as strings, retaining leading zeros. Handle missing accounts; do not recreate them automatically or mutate returned tables to change money.

lua

local result = exports['tgg-finance']:CreateBusinessAccount(
    'mechanic', 0, 'LS Customs', '#76abae'
)
if not result.success then
    return
end

CreateBusinessAccount(society, startBalance?, displayName?, color?) returns { success, error?, account? }. Existing accounts are not funded again. Funding failure can return an account with success = false; inspect before retrying.

AddSocietyMoney(society, amount) and RemoveSocietyMoney(society, amount) take positive amounts and return booleans. Restrictions, limits, or hooks can refuse them. Check for true; investigate exceptions or lost responses before repeating a payment.

Export	Purpose
`IsAccountFrozen(iban)`	Check the account freeze flag.
`FreezeAccount(iban)`	Place a privileged hold; returns a boolean.
`UnfreezeAccount(iban)`	Clear a hold; returns a boolean.
`IsAccountTerminated(iban)`	Check whether the account is closed/terminated.
`IsCardFrozen(cardId)`	Check a card's freeze flag.
`IsCardTerminated(cardId)`	Check termination.
`FreezeCard(cardId)`	Freeze a card; returns a boolean.
`UnfreezeCard(cardId)`	Clear a card's freeze flag; returns a boolean. This does not undo termination.

Use numeric card database IDs, not card numbers or slots. See Account freezes. Do not synchronously freeze an account from its own operation hook; the export can wait on its lock.

lua

local transactionId = exports['tgg-finance']:AddTransaction(
    toIban, fromIban, transactionType, amount,
    description, playerIdentifier, cardId, customTitle
)

toIban, fromIban, description, playerIdentifier, cardId, and customTitle can be omitted with nil where they do not apply. transactionType is a string and amount a number. The result is a transaction ID or nil.

History only: no money movement or cashback.

CreateInvoice(invoiceData) returns the created invoice table or nil. A minimal company-to-player example is:

lua

local invoice = exports['tgg-finance']:CreateInvoice({
    sender = 'mechanic',
    recipientType = 'player',
    recipientId = recipientCharacterIdentifier,
    recipientName = recipientDisplayName,
    items = {
        { label = 'Repair', price = 100, quantity = 1 },
    },
    total = 100,
    notes = 'Vehicle repair',
})

Configure mechanic first and resolve recipient variables server-side. Calculate total from items before tax. Omit taxPercentage to use configured tax. Finance generates id and display uuid.

Personal invoices require sender = '__personal' and the issuer's character identifier in senderId. Company recipients use recipientType = 'company' and their job identifier in recipientCompany; eligibility still applies. skipAcceptance = true makes an invoice unpaid immediately.

Creation trusts server callers and lacks the player path's online grade context. Validate client input and authorize acceptance bypasses yourself.

PayInvoice(playerSource, invoiceId) returns success and optionally the paid amount. CancelInvoice(playerSource, invoiceId) returns a boolean. Both enforce player/company permissions. Use the numeric invoice ID, not its display UUID.

🗄️ Server exports

Account lookup

Society accounts and funds

Account and card status

Transaction history

Invoices

On this page