QF Developers

https://wiki.qfdevelopers.com
Admin
QF Developers provides premium FiveM scripts designed for performance, flexibility, and ease of use,...
Tokens:11,448
Snippets:129
Trust Score:4.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### FiveM Server License Key Configuration Example

Source: https://wiki.qfdevelopers.com/general-informations/publish-your-docs-1

This snippet shows the configuration line for setting a FiveM server license key within a server's configuration file. This is crucial for validating script ownership and entitlements.

```cfg
sv_licenseKey "39dz2edscjkvnxklzciupczdijo"
```

--------------------------------

### Get Player Billing Statistics - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Fetches detailed billing statistics for a player, including daily, weekly, and monthly summaries. It requires the player's source and returns a data object containing various statistical metrics.

```lua
exports.qfbilling:GetPlayerStatistics(source, function(data)
    print("Invoices Today: " .. data.personal.stats.totalInvoices.today)
    print("Monthly Income: " .. data.personal.stats.totalIncome.month)
end)
```

--------------------------------

### Get Account Balance API

Source: https://wiki.qfdevelopers.com/scripts/editor-12/configuration

Retrieves the current bank account balance of a player. This endpoint requires a player ID to fetch the balance.

```APIDOC
## GET /player/balance

### Description
Retrieves the current bank account balance of a player.

### Method
GET

### Endpoint
/player/balance

### Parameters
#### Query Parameters
- **playerId** (number) - Required - The server ID of the player.

### Request Example
```json
{
  "playerId": 12345
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Whether the operation was successful.
- **result** (number|string) - The account balance if successful, or an error message if failed.

#### Response Example
```json
{
  "success": true,
  "result": 1500.50
}
```
```json
{
  "success": false,
  "result": "Player not found."
}
```
```

--------------------------------

### Get List of Societies - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Retrieves a list of all available societies from the database. It requires the player's source and returns a table of society objects, each with a label and name. Used for populating society-related UI elements.

```lua
exports.qfbilling:GetSocietiesList(source, function(societies)
    for _, society in ipairs(societies) do
        print(society.label .. " (" .. society.name .. ")")
    end
end)
```

--------------------------------

### Get Invoice Details by ID - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Fetches all details of a specific invoice using its unique ID. It returns an invoice object containing sender, recipient, amount, items, and status. Requires the invoice ID as input.

```lua
exports.qfbilling:GetInvoiceById(42, function(invoice)
    if invoice then
        print("Invoice ID:", invoice.id)
        print("Total:", invoice.amount)
        print("Status:", invoice.status)
    end
end)
```

--------------------------------

### Get Unpaid Invoices Count - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Retrieves the total count of unpaid invoices for a given player, along with summary data. It requires the player's source identifier and returns the count and associated data. Useful for prompting players about outstanding debts.

```lua
exports.qfbilling:GetUnpaidInvoicesCount(source, function(count, data)
    if count > 0 then
        print("You have " .. count .. " unpaid invoices.")
    end
end)
```

--------------------------------

### FiveM Server Console Command to Check License Key

Source: https://wiki.qfdevelopers.com/general-informations/publish-your-docs-1

Demonstrates the command used in a FiveM server console to display the currently active server license key. This is a diagnostic step to verify server configuration.

```console
sv_licenseKey
```

--------------------------------

### Framework Detection Configuration - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Automatically detects the server's framework (ESX, QBCore, QBox, VRP) to enable integrations. The configuration checks for the presence and running state of framework resources. This allows for dynamic integration without manual toggling.

```lua
Config.Frameworks = {
    ESX = { enabled = GetResourceState('es_extended') == 'started' },
    QBCore = { enabled = GetResourceState('qb-core') == 'started' },
    QBox = { enabled = GetResourceState('qbx-core') == 'started' },
    VRP = { enabled = false },
}
```

--------------------------------

### Configure Sound and Hotkey Settings in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Enhances user experience by enabling sound effects for invoice creation and payment, and allowing a configurable hotkey (default 'F7') to quickly access the billing UI. Controlled by `Config.EnableSounds`, `Config.PlaySoundOnCreate`, `Config.PlaySoundOnPay`, `Config.EnableKeybind`, and `Config.DefaultKey`.

```lua
Config.EnableSounds = true
Config.PlaySoundOnCreate = true
Config.PlaySoundOnPay = true
Config.EnableKeybind = true
Config.DefaultKey = "F7"
```

--------------------------------

### Client-side Text UI Prompts with `exports.qf_notify:textui`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Displays a temporary key-based text prompt on screen. Supports key, title, description, and state (show/hide). Includes type safety and character limits for title and description.

```lua
exports.qf_notify:textui({
    key = 'E',                        -- string: key shown in UI
    title = 'Interact',              -- string: max 100 characters
    description = 'Press E to use',  -- string: max 300 characters
    state = true                     -- boolean: true = show, false = hide
})
```

--------------------------------

### Create Player Invoice with Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Creates a new invoice from one player to another. It requires the source player ID, target player ID, a table of items with labels, prices, and quantities, and the invoice type ('personal' or 'society'). Returns a boolean indicating success.

```lua
exports.qfbilling:CreateInvoice(
    source,
    targetId,
    {
        { label = 'Traffic Violation', price = 500, quantity = 1 },
        { label = 'Parking Fee', price = 200, quantity = 1 }
    },
    'personal'
)
```

--------------------------------

### CreateInvoice API

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Allows a player to create a new invoice for another player.

```APIDOC
## POST /api/billing/createInvoice

### Description
Creates a new invoice from one player to another.

### Method
POST

### Endpoint
/api/billing/createInvoice

### Parameters
#### Request Body
- **sourcePlayer** (number) - Required - ID of the player creating the invoice
- **targetPlayer** (number) - Required - ID of the player receiving the invoice
- **items** (table) - Required - Table of billed items `{ label, price, quantity }`
- **invoiceType** (string) - Required - Type of invoice (`personal` or `society`)

### Request Example
```json
{
  "sourcePlayer": 1,
  "targetPlayer": 2,
  "items": [
    { "label": "Traffic Violation", "price": 500, "quantity": 1 },
    { "label": "Parking Fee", "price": 200, "quantity": 1 }
  ],
  "invoiceType": "personal"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - true if successfully created.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Configure Invoice Notification Settings in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Manages how players receive notifications for billing events, including enabling/disabling them, choosing a notification system, setting display duration, and customizing colors for different message types (success, error, info, warning).

```lua
Config.ShowNotifications = true
Config.NotificationSystem = "nui"
Config.NotificationDuration = 5000  -- milliseconds
Config.NotificationColors = {
    success = "#4CAF50",
    error = "#f44336",
    info = "#2196F3",
    warning = "#ff9800",
}
```

--------------------------------

### Configure ACE Permissions for Skin Menu Access

Source: https://wiki.qfdevelopers.com/scripts/editor-13/configuration

This configuration snippet shows how to grant the 'manageSkinMenu' ACE permission to players or groups. This permission is required to use the /skin command and access peds in the skin menu. It supports various identifier types like Discord ID and FiveM license, as well as ACE groups.

```cfg
add_ace identifier.discord:YOUR_DISCORD_ID manageSkinMenu allow

add_ace identifier.discord:541714961576099853 manageSkinMenu allow

add_ace identifier.license:5a351fe45f0428603e660fda37244dac8eecfbdc manageSkinMenu allow

add_ace group.admin manageSkinMenu allow
```

--------------------------------

### Configure Invoice Amount Limits in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Sets the minimum and maximum allowed values for invoices. These values should be adjusted based on the server's economy scale to prevent under or over-invoicing. Configured using `Config.MinimumInvoiceAmount` and `Config.MaximumInvoiceAmount`.

```lua
Config.MinimumInvoiceAmount = 1
Config.MaximumInvoiceAmount = 999999
```

--------------------------------

### Client-to-Client Text UI Trigger `qf_notify/showTextUI`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a key-based UI prompt locally from one client-side script to another. Internally calls `exports.qf_notify:textui` with the specified parameters.

```lua
TriggerEvent('qf_notify/showTextUI', {
    state = true,
    key = 'E',
    title = 'Open Locker',
    description = 'Press E to open your locker.'
})
```

--------------------------------

### CreateInvoiceForSociety API

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Enables the creation of an invoice addressed to a company or registered society.

```APIDOC
## POST /api/billing/createInvoiceForSociety

### Description
Creates an invoice addressed to a company or registered society.

### Method
POST

### Endpoint
/api/billing/createInvoiceForSociety

### Parameters
#### Request Body
- **sourcePlayer** (number) - Required - ID of the player issuing the invoice
- **targetSociety** (string) - Required - Target society name (e.g. `police`, `ambulance`)
- **items** (table) - Required - Items list `{ label, price, quantity }`
- **invoiceType** (string) - Optional - Defaults to `society`

### Request Example
```json
{
  "sourcePlayer": 1,
  "targetSociety": "mechanic",
  "items": [
    { "label": "Vehicle Service", "price": 5000, "quantity": 1 },
    { "label": "Spare Parts", "price": 1200, "quantity": 2 }
  ]
}
```

### Response
#### Success Response (200)
- **success** (boolean) - true if successfully created.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Configure Discord Logging for Billing Events in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Enables sending billing event logs to Discord via webhooks for auditing. Administrators can configure specific webhooks for different events (main, created, paid) and set custom colors for Discord messages based on event status.

```lua
Config.EnableDiscordLogs = true
Config.DiscordWebhooks = {
    main = "https://discord.com/api/webhooks/your-main-webhook",
    created = "https://discord.com/api/webhooks/created-webhook",
    paid = "https://discord.com/api/webhooks/paid-webhook",
}
Config.DiscordColors = {
    created = 3447003,   -- Blue
    paid = 3066993,      -- Green
    canceled = 15158332, -- Red
}
```

--------------------------------

### Create Society Invoice with Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Creates an invoice addressed to a company or registered society. It requires the source player ID, the target society name, a table of items, and an optional invoice type which defaults to 'society'.

```lua
exports.qfbilling:CreateInvoiceForSociety(
    source,
    'mechanic',
    {
        { label = 'Vehicle Service', price = 5000, quantity = 1 },
        { label = 'Spare Parts', price = 1200, quantity = 2 }
    }
)
```

--------------------------------

### Server-to-Client Text UI Trigger `qf_notify/showTextUI`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a temporary text UI element from the server to a specific client. Delegates to the client-side `exports.qf_notify:textui` function with the provided data.

```lua
TriggerClientEvent('qf_notify/showTextUI', source, {
    state = true,
    key = 'E',
    title = 'Talk to the NPC',
    description = 'Press E to interact.'
})
```

--------------------------------

### Server-to-Client Notification Trigger `qf_notify/showNotification`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a standard notification from the server to a specific client. Delegates to the client-side `exports.qf_notify:notify` function and accepts similar parameters.

```lua
TriggerClientEvent('qf_notify/showNotification', source, {
    type = 'success',
    title = 'Success',
    description = 'Action completed successfully!',
    timeout = 5000
})
```

--------------------------------

### Client-side Notifications with `exports.qf_notify:notify`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Displays a styled notification to the client. Supports type, title, description, and timeout. Validation is applied for types, character limits, and durations when safeguards are enabled.

```lua
exports.qf_notify:notify({
    type = 'success',          -- string: 'success', 'info', 'error', 'warning'
    title = 'Notification',    -- string: max 100 characters
    description = 'You did it!', -- string: max 300 characters
    timeout = 5000             -- number: duration in milliseconds
})
```

--------------------------------

### Add Money API

Source: https://wiki.qfdevelopers.com/scripts/editor-12/configuration

Adds money to a player's bank account. This operation requires the player ID and the amount to add.

```APIDOC
## POST /player/add_money

### Description
Adds money to a player's bank account.

### Method
POST

### Endpoint
/player/add_money

### Parameters
#### Request Body
- **playerId** (number) - Required - The server ID of the player.
- **amount** (number) - Required - The amount of money to add.

### Request Example
```json
{
  "playerId": 12345,
  "amount": 100.00
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Whether the operation was successful.
- **result** (string) - Success or error message.

#### Response Example
```json
{
  "success": true,
  "result": "100.00 added successfully."
}
```
```json
{
  "success": false,
  "result": "Invalid amount."
}
```
```

--------------------------------

### GetPlayerInvoices API

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Retrieves all invoices associated with a player, including personal, society, and sent invoices, along with their current money balance.

```APIDOC
## GET /api/billing/getPlayerInvoices

### Description
Retrieves all invoices belonging to a player (personal, society, and sent).

### Method
GET

### Endpoint
/api/billing/getPlayerInvoices

### Parameters
#### Query Parameters
- **source** (number) - Required - Player ID

### Request Example
```http
GET /api/billing/getPlayerInvoices?source=1
```

### Response
#### Success Response (200)
- **invoices** (object) - Table containing categorized invoices (`personal`, `society`, `sent`).
- **money** (number) - Player's current money balance.

#### Response Example
```json
{
  "invoices": {
    "personal": [
      { "id": 1, "description": "Invoice 1", "amount": 100 },
      { "id": 2, "description": "Invoice 2", "amount": 200 }
    ],
    "society": [
      { "id": 3, "description": "Society Invoice 1", "amount": 500 }
    ],
    "sent": [
      { "id": 4, "description": "Sent Invoice 1", "amount": 150 }
    ]
  },
  "money": 1000
}
```
```

--------------------------------

### Client-side Progress Bars with `exports.qf_notify:progress`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Displays a timed progress bar with an optional callback. Supports time, text, and a force option to bypass existing progress bars. Validation ensures callback is a function and time is within limits.

```lua
exports.qf_notify:progress({
    time = 5000,               -- number: duration in milliseconds (max 60000)
    text = 'Processing...',    -- string
    callback = function()
        print("Progress finished")
    end,
    force = false              -- (optional) bypass running progress
})
```

--------------------------------

### Retrieve Player Invoices with Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Retrieves all invoices belonging to a player, including personal, society, and sent invoices. It takes the player's source ID and a callback function that receives the invoices table and the player's money balance.

```lua
exports.qfbilling:GetPlayerInvoices(source, function(invoices, money)
    print("Wallet: " .. money)
    print("Personal invoices: " .. #invoices.personal)
    print("Society invoices: " .. #invoices.society)
end)
```

--------------------------------

### Force Pay Invoice (Admin) - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Allows administrators to manually mark an invoice as paid. It requires the invoice ID, player ID, and a callback function that receives a success status and a message. This is an administrative-only function.

```lua
exports.qfbilling:ForcePayInvoice(invoiceId, playerId, function(success, message)
    print(message)
end)
```

--------------------------------

### Server-to-Client Progress Bar Trigger `qf_notify/showProgressBar`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a progress bar from the server to a specific client. Delegates to the client-side `exports.qf_notify:progress` function. Note that callbacks are not supported when triggered via event.

```lua
TriggerClientEvent('qf_notify/showProgressBar', source, {
    time = 7000,
    text = 'Processing...'
})
```

--------------------------------

### Unbind Key via F8 Console

Source: https://wiki.qfdevelopers.com/general-informations/publish-your-docs

This command allows players to unbind a specific key from its assigned action directly through the in-game F8 console. It requires the 'keyboardinput_parameter' to be replaced with the actual key the user wishes to unbind.

```lua
unbind keyboardinput_parameter
```

--------------------------------

### Client-to-Client Notification Trigger `qf_notify/showNotification`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a notification locally from one client-side script to another. Internally calls `exports.qf_notify:notify` and supports the same notification types.

```lua
TriggerEvent('qf_notify/showNotification', {
    type = 'info',
    title = 'Info',
    description = 'This is a local test notification.',
    timeout = 4000
})
```

--------------------------------

### Society Names Mapping Configuration - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Defines user-friendly display names for in-game jobs or societies. This configuration maps internal society names (keys) to display labels. These names are used in invoices and UI elements to improve clarity for players.

```lua
Config.Societies = {
    ["police"] = "LSPD",
    ["ambulance"] = "EMS",
    ["mechanic"] = "Benny's Garage",
    ["taxi"] = "Downtown Cab Co.",
    -- Add others as needed
}
```

--------------------------------

### Client-to-Client Progress Bar Trigger `qf_notify/showProgressBar`

Source: https://wiki.qfdevelopers.com/scripts/editor-9/configuration

Triggers a progress bar locally from one client-side script to another. Internally calls `exports.qf_notify:progress`. Callbacks are not supported when triggered via event.

```lua
TriggerEvent('qf_notify/showProgressBar', {
    time = 5000,
    text = 'Cleaning up area...'
})
```

--------------------------------

### Configure Job and Grade Restrictions for Invoices in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Restricts who can create or pay society invoices based on job grade. `Config.EnableGradeRestriction` must be true to activate these settings. Permissions like `viewAndCreate`, `pay`, and `analytics` can be assigned specific grade levels.

```lua
Config.EnableGradeRestriction = true
Config.MinimumGradeLevel = 2
Config.SocietyGradePermissions = {
    viewAndCreate = 0,
    pay = 0,
    analytics = 4,
    viewSentInvoices = 0,
}
```

--------------------------------

### Check for Unpaid Invoices - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Performs a lightweight boolean check to determine if a player has any outstanding invoices. It takes the player's source and returns a boolean indicating presence of unpaid invoices. Useful for gating actions or preventing progression.

```lua
exports.qfbilling:HasUnpaidInvoices(source, function(hasUnpaid)
    if hasUnpaid then
        print("Player cannot proceed - unpaid invoices detected.")
    else
        print("No outstanding debt.")
    end
end)
```

--------------------------------

### Configure Proximity Check for Invoice Creation in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Enforces that users must be within a certain distance to create invoices, promoting realism and preventing abuse. The check is enabled if `Config.RequireNearbyTarget` is greater than 0, and the maximum distance is set by `Config.MaxDistanceForNearbyPlayers`.

```lua
Config.RequireNearbyTarget = 0      -- 0 = disabled
Config.MaxDistanceForNearbyPlayers = 5.0  -- meters
```

--------------------------------

### Add Income to Chart - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Adds income data to an internal analytics chart. This function is used to record financial transactions for reporting purposes. It requires a chart identifier, a category, and the income amount.

```lua
exports.qfbilling:AddIncomeToChart("char1123456", "mechanic", 5000)
```

--------------------------------

### Enable Invoice Cancellation in Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Allows users to cancel invoices they have sent or received. This feature helps manage disputes and provides flexibility in the billing process. Controlled by `Config.AllowCancelInvoices` and `Config.AllowCancelReceivedInvoices`.

```lua
Config.AllowCancelInvoices = true
Config.AllowCancelReceivedInvoices = true
```

--------------------------------

### Cancel Invoice (Admin) - Lua

Source: https://wiki.qfdevelopers.com/scripts/editor/configuration

Enables administrators to cancel a specific invoice. It takes the invoice ID and a callback function that reports success. This function is restricted to administrative use.

```lua
exports.qfbilling:CancelInvoice(invoiceId, function(success)
    if success then
        print("Invoice has been successfully cancelled.")
    end
end)
```

--------------------------------

### Remove Money API

Source: https://wiki.qfdevelopers.com/scripts/editor-12/configuration

Removes money from a player's bank account. This operation requires the player ID and the amount to remove.

```APIDOC
## POST /player/remove_money

### Description
Removes money from a player's bank account.

### Method
POST

### Endpoint
/player/remove_money

### Parameters
#### Request Body
- **playerId** (number) - Required - The server ID of the player.
- **amount** (number) - Required - The amount of money to remove.

### Request Example
```json
{
  "playerId": 12345,
  "amount": 50.00
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Whether the operation was successful.
- **result** (string) - Success or error message.

#### Response Example
```json
{
  "success": true,
  "result": "50.00 removed successfully."
}
```
```json
{
  "success": false,
  "result": "Insufficient funds."
}
```
```
Tokens:
Raw