Server Exports

CreateAtmBusinessOwner

Creates a new ATM business owner.

---@param data table Owner data table containing:
---   - name (string) Owner's display name
---   - identifier/citizenid (string) Unique player identifier (e.g., license:abc123)
---   - totalAtmLimit (number) Maximum number of ATMs this owner can have
---   - allowedCommissionPercentage (number, optional) Commission percentage (default: 10)
---@return boolean success Whether the operation was successful
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:CreateAtmBusinessOwner({
    name = "John Doe",
    identifier = "license:abc123def456",
    totalAtmLimit = 5,
    allowedCommissionPercentage = 15
})

GetAllAtmBusinessOwners

Retrieves all ATM business owners.

---@return table owners Array of owner objects, or empty table if none found
exports['g-atm-business']:GetAllAtmBusinessOwners()

GetAtmBusinessOwnerById

Retrieves an ATM business owner by identifier.

---@param identifier | citizenid string The identifier of the ATM business owner
---@return table|nil owner Owner object if found, nil if not found
exports['g-atm-business']:GetAtmBusinessOwnerById(identifier)

DeleteAtmBusinessOwner

Deletes an ATM business owner.

---@param identifier | citizenid string The identifier of the ATM business owner to delete
---@return boolean success Whether the operation was successful
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:DeleteAtmBusinessOwner(identifier)

IsUserAlreadyAdded

Checks if a user is already added.

---@param identifier | citizenid string The identifier to check
---@return boolean exists True if the user is already added, false otherwise
exports['g-atm-business']:IsUserAlreadyAdded(identifier)

GetBalancesForOwners

Gets total balance for multiple owners

---@param ownerIdentifiers table Array of owner identifier strings
---@return table balanceMap Map/dictionary where keys are owner identifiers and values are total balances
exports['g-atm-business']:GetBalancesForOwners(ownerIdentifiers)

Example usage:

-- Example usage:
-- if qbcore/qbox use citizenid
local identifiers = {
    "license:abc123def456",
    "license:xyz789ghi012",
    "license:def456jkl345"
}

local balances = exports['g-atm-business']:GetBalancesForOwners(identifiers)

for identifier, balance in pairs(balances) do
    print(string.format("Owner %s has balance: $%d", identifier, balance))
end

isOwner

Checks if a user is an owner.

---@param identifier string The identifier to check
---@return boolean isOwner True if the user is an owner, false otherwise
exports['g-atm-business']:isOwner(identifier)

CheckAndRequireService

Checks if an ATM requires servicing.

---@param atmId number The ID of the ATM to check
---@return nil No return value
exports['g-atm-business']:CheckAndRequireService(atmId)

CreateAtm

Creates a new ATM.

---@param data table ATM data table containing:
---   - name (string) ATM name
---   - ownerIdentifier (string) Owner identifier
---   - ownerName (string) Owner name
---   - location (table) Location data with x, y, z, w, rotationX, rotationY, rotationZ
---   - atmModelConfigIndexId (number) ATM model config index ID
---   - configIndexId (number) Config index ID
---   - spawnCode (string) Spawn code
---   - balance (number, optional) Initial balance (default: 0)
---   - status (string, optional) Status (default: 'active')
---   - commissionPercentage (number, optional) Commission percentage
---   - thermalPaper (table, optional) Thermal paper data with amount and lowAlertAmount
---@return number|nil insertId The ID of the created ATM or nil if failed
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:CreateAtm(data)

Example usage:

-- Example usage:
local insertId, error = exports['g-atm-business']:CreateAtm({
    name = "ATM Downtown",
    ownerIdentifier = "license:abc123def456",
    ownerName = "John Doe",
    atmModelConfigIndexId = 1,
    configIndexId = 1,
    spawnCode = "atm_001",
    location = {
        x = 100.0,
        y = 200.0,
        z = 30.0,
        w = 0.0,
        rotationX = 0.0,
        rotationY = 0.0,
        rotationZ = 90.0
    },
    balance = 50000,
    thermalPaper = {
        amount = 1000,
        lowAlertAmount = 100
    }
})

GetAtmOwnerIdentifierById

Retrieves atm owner identifier by atm id

---@param atmId number The ID of the ATM
---@return string|nil ownerIdentifier The owner identifier or nil if not found
exports['g-atm-business']:GetAtmOwnerIdentifierById(atmId)

GetAtmsByOwnerIdentifier

Retrieves all ATMs by owner identifier.

---@param ownerIdentifier string The owner identifier/citizenid
---@return table[] atms Array of ATM data
exports['g-atm-business']:GetAtmsByOwnerIdentifier(ownerIdentifier)

UpdateAtmThermalPaper

Updates the thermal paper amount of an ATM.

---@param atmId number The ID of the ATM
---@param amount number The amount of thermal paper to add or reduce
---@param operation string The operation type: 'add' or 'reduce' (default: 'reduce')
---@return boolean success Whether the operation was successful
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:UpdateAtmThermalPaper(atmId, amount, operation)

CreateUserTransaction

Creates a user transaction.

---@param data table Transaction data table containing:
---   - atmId (number) ATM ID
---   - identifier (string) User identifier
---   - userName (string) User name
---   - amount (number) Transaction amount
---   - type (string) Transaction type: 'deposit' or 'withdraw'
---   - commissionEarned (number, optional) Commission earned
---@return number|nil insertId The ID of the created transaction or nil if failed
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:CreateUserTransaction(data)

Example usage:

-- Example usage:
local insertId, error = exports['g-atm-business']:CreateUserTransaction({
    atmId = 123,
    identifier = "license:xyz789", -- if qbcore/qbox use citizenid
    userName = "Jane Doe",
    amount = 1000,
    type = "deposit",
    commissionEarned = 10
})

GetTransactionDataById

Retrieves transaction data by ID.

---@param transactionId number The ID of the transaction
---@return table|nil transaction The transaction data or nil if not found
exports['g-atm-business']:GetTransactionDataById(transactionId)

DepositOwnerAccount

Deposits money into an owner account.

---@param ownerIdentifier string The owner identifier/citizenid 
---@param amount number The amount to deposit (must be positive)
---@param atmId number|nil Optional ATM ID for transaction logging
---@return boolean success Whether the operation was successful
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:DepositOwnerAccount(ownerIdentifier, amount, atmId)

WithdrawOwnerAccount

Withdraws money from an owner account

---@param ownerIdentifier string The owner identifier/citizenid
---@param amount number The amount to withdraw (must be positive)
---@param atmId number|nil Optional ATM ID for transaction logging
---@return boolean success Whether the operation was successful
---@return string|nil error Error message if operation failed, nil if successful
exports['g-atm-business']:WithdrawOwnerAccount(ownerIdentifier, amount, atmId)