Banking - Exports - Server - Lation Scripts Docs

Accounts are addressed by id: a job or gang name for society accounts, the account number for shared accounts, a player identifier for personal accounts, and the id your resource chose for a business account.

A personal account is your framework’s own bank balance. Reading it and moving money work whether or not that player is connected.

Accounts

GetAccount

Returns an account, or nil when there is no such account.

local account = exports.lation_banking:GetAccount('police')

string

required

A job or gang name, an account number, or a player identifier.

{
  id      = 'police',
  type    = 'society',   -- personal, savings, society, shared or business
  name    = 'Los Santos Police',
  number  = 'LS88001000',
  balance = 1250000,
  owner   = nil,
  frozen  = false,
  members = {},
}

GetAccountBalance

Returns the balance, or nil when there is no such account.

local balance = exports.lation_banking:GetAccountBalance('ballas')

string

required

The account to read.

GetPlayerAccounts

Returns every savings, society and shared account this player may use, each with their role and permissions.

local accounts = exports.lation_banking:GetPlayerAccounts(identifier)

A society the player holds through their job or gang only appears while they are connected.

string

required

The player’s identifier.

GetPlayerAccountNumber

Returns a player’s personal account number.

local number = exports.lation_banking:GetPlayerAccountNumber(identifier)

string

required

The player’s identifier.

GetIdentifierByAccountNumber

The reverse: the identifier behind a personal account number, or nil.

local identifier = exports.lation_banking:GetIdentifierByAccountNumber('LS48219930')

string

required

A personal account number, with or without spacing.

CreateAccount

Opens a society, shared or business account. Returns the account, or nil and a reason (exists, invalid, invalid_name, database).

local account, err = exports.lation_banking:CreateAccount({
  type = 'shared', name = 'Crew Fund', owner = identifier, balance = 0
})

string

required

What the account is called.

string

"society", "shared" or "business". Defaults to "shared".

string

Required for a society account: the job or gang name. Required for a business account: an id of your own, prefixed with your resource (myshop:24_7), up to 50 characters. Shared accounts are given a number.

string

The identifier of the player who owns it. A business account may have none while nobody owns it.

number

What it opens with. Defaults to 0.

DeleteAccount

Closes an account. The balance is not returned to anyone: move it first.

exports.lation_banking:DeleteAccount('LS12345678')

string

required

The account to close.

RenameAccount

exports.lation_banking:RenameAccount('police', 'Los Santos Sheriff')

string

required

The account to rename.

string

required

The new name.

SetAccountOwner

Hands a shared or business account to another player. A business account may be left with nobody (nil) while it is between owners; its money stays.

exports.lation_banking:SetAccountOwner('myshop:24_7', identifier)

string

required

The account.

string

The new owner. nil leaves a business account unowned; a shared account always has one.

SetAccountFrozen

A frozen account can be seen but not used.

exports.lation_banking:SetAccountFrozen('ballas', true)

string

required

The account to freeze or unfreeze.

boolean

required

true to freeze it.

Money

AddAccountMoney

Pays into an account and records the move with your reason.

exports.lation_banking:AddAccountMoney('police', 2500, 'Impound fee')

string

required

The account to credit.

number

required

A positive whole amount.

string

What it was for. This is what shows in the history.

RemoveAccountMoney

Takes money out. Returns false when the balance cannot cover it; the balance can never go negative.

exports.lation_banking:RemoveAccountMoney('police', 900, 'Ammunition')

string

required

The account to debit.

number

required

A positive whole amount.

string

What it was for.

TransferMoney

Moves money between any two accounts and writes both halves of the transfer. Returns false and a message when it cannot.

local ok, message = exports.lation_banking:TransferMoney('police', 'LS12345678', 1000, 'Consulting')

string

required

The account paying.

string

required

The account being paid.

number

required

A positive whole amount.

string

What it was for.

Members

AddAccountMember

Gives a player access to a shared or business account.

exports.lation_banking:AddAccountMember('LS12345678', identifier, {
  deposit = true, withdraw = false, transfer = false, manage = false
})

string

required

The account.

string

required

The player being added.

table

Any of deposit, withdraw, transfer and manage. Deposit only by default. Members of a business account never get manage.

UpdateAccountMember

Changes what an existing member may do.

exports.lation_banking:UpdateAccountMember('LS12345678', identifier, { withdraw = true })

string

required

The account.

string

required

The member.

table

required

The permissions to set.

RemoveAccountMember

exports.lation_banking:RemoveAccountMember('LS12345678', identifier)

string

required

The account.

string

required

The member to remove.

ClearAccountMembers

Removes every member at once.

exports.lation_banking:ClearAccountMembers('myshop:24_7')

string

required

The account.

GetAccountMembers

Returns everyone with access, with their names and permissions.

local members = exports.lation_banking:GetAccountMembers('LS12345678')

string

required

The account to read.

Transactions

AddTransaction

Writes a line in the history without moving money, for scripts that move it themselves and want it labelled properly. When tracking already caught that move on a personal account, this names that line instead of adding a second one.

exports.lation_banking:AddTransaction(identifier, {
  type = 'income', amount = 1200, note = 'Weekly rent', counterparty = 'Vinewood Rentals'
})

string

required

The account the line belongs to.

string

required

deposit, withdraw, transfer_in, transfer_out, income or expense.

number

required

A positive whole amount.

string

What it was for.

string

Who was on the other side.

GetTransactions

Returns a page of the history with its totals.

local page = exports.lation_banking:GetTransactions('police', { page = 1, perPage = 25 })

string

required

The account to read.

number

Which page. Defaults to 1.

number

Rows per page, up to 500. Defaults to 25.

table

Any of types, search, dateFrom and dateTo.

Bills & loans

CreateBill

Sends a bill to a player. Returns its id, or nil and a reason.

local id = exports.lation_banking:CreateBill({
  target = identifier, amount = 1500, note = 'Speeding', account = 'police'
})

string

required

Who pays: an identifier or an account number.

number

required

A positive whole amount.

string

Where the money lands when it is paid. Leave it out for a fine that leaves the economy.

string

What the bill is for.

string

The name on the bill. Defaults to the account’s name, or your resource.

number

Unix time. Defaults to the days set in /bankadmin.

PayBill

Pays a bill on the player’s behalf. The only export that needs them connected, because paying takes their transaction lock. Returns false and a message when it cannot.

local ok, message = exports.lation_banking:PayBill(id)

number

required

The bill id.

string

Which of their accounts pays. Defaults to their personal one.

CancelBill

Withdraws an unpaid bill.

exports.lation_banking:CancelBill(id)

number

required

The bill id.

GetBills

Returns the bills sent to a player, newest first.

local unpaid = exports.lation_banking:GetBills(identifier, 'unpaid')

string

required

The player.

string

unpaid, paid, declined, cancelled or expired. All of them when left out.

GetLoan

Returns the loan a player is paying off, or nil.

local loan = exports.lation_banking:GetLoan(identifier)

string

required

The player.

Point of sale

A register’s menu belongs to a business listed in /bankadmin under Point of sale; accountId is that society’s id.

GetPosProducts

Returns a register’s menu.

local products = exports.lation_banking:GetPosProducts('burgershot')
-- { { id = 12, category = 'Drinks', label = 'Cola', price = 5, item = 'cola' }, ... }

string

required

The business.

AddPosProduct

Adds a product to a register’s menu. Returns its id, or nil and a reason.

local id, err = exports.lation_banking:AddPosProduct('burgershot', {
  label = 'Cola', price = 5, category = 'Drinks', item = 'cola'
})

string

required

The business.

string

required

What the product is called on the register.

number

required

A whole amount. 0 lists it without a price, for a boss to set.

string

The tab it sits under.

string

An inventory item, for the picture.

RemovePosProduct

exports.lation_banking:RemovePosProduct(id)

number

required

The product id.

Other

OpenBank

Opens the bank for a player from the server.

exports.lation_banking:OpenBank(source, 'atm')

number

required

The player.

string

"bank", "atm", "admin", "bill" or "pos". Defaults to "bank"; "admin" is refused without the ACE permission.

RequestPin

Shows the player the bank’s PIN pad and waits. Returns true when they enter the right PIN, and at once when PINs are off in /bankadmin or the account has none, so you can always call it and the server’s settings decide. Returns false when they close the pad, run out of the ATM’s three tries, or already have the bank open.

if exports.lation_banking:RequestPin(source) then
  openTheSafe(source)
end

number

required

The player.

string

A shared or business account to check instead of the player’s own PIN.

GetConfig

Returns the live configuration as /bankadmin last saved it. Logging is not included.

local loans = exports.lation_banking:GetConfig('loans')

string

One of general, currency, banks, blip, atm, accounts, transfers, transactions, bills, requests, pos, savings or loans. Every section when left out.

Events

lation_banking:transaction

Fires on the server for every movement the bank records, on any account, with the row as stored. This is how another resource keeps its own copy of a balance in step, see Business accounts.

AddEventHandler('lation_banking:transaction', function(tx)
  -- tx.accountId, tx.type, tx.amount, tx.balanceAfter, tx.note,
  -- tx.counterparty, tx.actorIdentifier, tx.actorName
end)

Field	Meaning
`type`	`deposit`, `withdraw`, `transfer_in`, `transfer_out`, `income` or `expense`.
`balanceAfter`	The account’s balance once the move landed.
`actorName`	The resource that called an export, or the player behind a UI action. Skip your own moves by comparing it with `GetCurrentResourceName()`.

Hooks

Server hooks live in server/utils/hooks.lua, which ships open under escrow. Edit the functions in place to add your own rules and reactions.

Function	Purpose
`Hooks.canOpen(source, kind)`	Return `false`, optionally with a message, to refuse the bank, an ATM, the bill card, a register (`pos`) or the card a customer pays a sale on (`pos_charge`).
`Hooks.canTransact(data)`	Return `false` to refuse a deposit, withdrawal, transfer, bill payment or sale (`pos`). Nothing has moved yet.
`Hooks.onTransaction(transaction)`	Runs after every recorded transaction, from the UI, the exports and other scripts’ money moves.
`Hooks.onAccountChange(data)`	Runs when a shared account is opened or closed, or a member is added, changed or removed.
`Hooks.ongoingPayments(source, identifier)`	What the player owes other resources, listed under their bills. Ships wired to jg-dealerships.

Looking for an export we don’t have listed here? Contact us and we’ll do what we can!

​Accounts

​GetAccount

​GetAccountBalance

​GetPlayerAccounts

​GetPlayerAccountNumber

​GetIdentifierByAccountNumber

​CreateAccount

​DeleteAccount

​RenameAccount

​SetAccountOwner

​SetAccountFrozen

​Money

​AddAccountMoney

​RemoveAccountMoney

​TransferMoney

​Members

​AddAccountMember

​UpdateAccountMember

​RemoveAccountMember

​ClearAccountMembers

​GetAccountMembers

​Transactions

​AddTransaction

​GetTransactions

​Bills & loans

​CreateBill

​PayBill

​CancelBill

​GetBills

​GetLoan

​Point of sale

​GetPosProducts

​AddPosProduct

​RemovePosProduct

​Other

​OpenBank

​RequestPin

​GetConfig

​Events

​lation_banking:transaction

​Hooks

Accounts

GetAccount

GetAccountBalance

GetPlayerAccounts

GetPlayerAccountNumber

GetIdentifierByAccountNumber

CreateAccount

DeleteAccount

RenameAccount

SetAccountOwner

SetAccountFrozen

Money

AddAccountMoney

RemoveAccountMoney

TransferMoney

Members

AddAccountMember

UpdateAccountMember

RemoveAccountMember

ClearAccountMembers

GetAccountMembers

Transactions

AddTransaction

GetTransactions

Bills & loans

CreateBill

PayBill

CancelBill

GetBills

GetLoan

Point of sale

GetPosProducts

AddPosProduct

RemovePosProduct

Other

OpenBank

RequestPin

GetConfig

Events

lation_banking:transaction

Hooks