📌Billing Locations

You can define as many billing locations as you require in Config.Billing in billing.lua

The key is the location name and must match the key in Config.CoreSettings.Jobs to function as intended. The job name you define must also be in your ``QB-Core/shared/jobs.lua.

---

Location Name

• The key is the location name and must match throughout

--billing locations
Config.Billing = {
    ['Example Billing Location'] = { -- the key is the location name and must match throughout
        ---
    },
}

---

Interaction Locations

• Define locations for target zones allowing players to interact and open the billing interface

• The name is the zone name and must be unique for caching

• Set enabled to true to use this interaction location

• Set debug to true to visually debug the interaction location

• The coords must be a vector3 value

• radius is the zone size radius

• distance is the maximum distance allowed for interaction (do not set this figure higher than the MaxDistance figure set in Config.CoreSettings.Security

• icon is the target icon

• label is the target label

• job is the job that can access this location. This is the job you define in Config.CoreSettings.Jobs

• args when making a location ensure you pass the locationName which is the key of the location

locations = { -- interaction locations
    {
        name = 'example_payment_1', -- zone namemust be unique
        enabled = true, debug = true, -- enable zone / debug zone
        coords = vector3(442.65, -980.17, 31.0), -- zone coords (must be vector3)
        radius = 0.5, distance = 3.0, -- zone radius / interaction distance
        icon = 'fa-solid fa-cash-register', -- target icon
        label = 'Open Billing', -- target label
        job = Config.CoreSettings.Jobs['Example Billing Location'].name, -- job required to interact
        args = { locationName = 'Example Billing Location', }, -- send locationName args (match the key)
    },
    --add more locations as required
},

---

Blips

• Each location can have its own custom blip

• Set enabled to true to use a blip for this location

• id is the blip id

• colour is the blip colour

• scale is the blip scale on the map

• title is the name of the blip

blip = { -- blip settings
    enabled = true, -- enable blip for this location
    id = 58, colour = 5, scale = 0.6, -- blip id, blip colour and blip scale
    title = 'Example Billing Location Blip', -- blip title
},

---

Commission

• Each location can have its own commission settings

• Set enabled to true to use the commission system for this location

• Define the commision percent you want from each sale paid to the employee

commission = { -- commission settings
    enabled = true, -- enable player commission
    percent = 20, -- commission percent of total bill value
},

---

Rank Requirement Access

• Each location can have its own minimum job rank requirement to use the billing interface

• Set enabled to true to use the minimum job rank system for this location

• Define the minimum rank required to access the billing interface

access = { -- job access settings
    enabled = true, -- enable job rank check
    rank = 1, -- min job rank required
},

---

Progress Circle

• Each location can have unique progress data with animations and a prop

• The label is the label of the progress circle (the % is the billing characters name do not edit this)

• The duration is the length of the progress circle in seconds

• Define animation data in the anim table providing the dict , clip and the flag

• Define prop data for the animation in the prop table providing the model , bone , pos and rot

progress = { -- progrss Circle settings
    label = 'Sending bill to %s', -- progrssCircle label (the %s is the characters name dont touch that)
    duration = 5, -- time in seconds for progressCircle
    anim = { dict = 'missheistdockssetup1clipboard@base', clip = 'base', flag = 49, }, -- animation settings
    prop = { model = 'prop_notepad_01', bone = 18905, pos = vec3(0.1, 0.02, 0.05), rot = vec3(10.0, 0.0, 0.0), }, -- prop settings
},

---

Payment Types

• Each location can have unique payment types allowed at this location

• Define which payment method you want available by setting the relevant boolean value to true or false

• Both payment types can be accepted by enabled both to true

paymentType = { -- which types of payment can be accepted here
    cash = true, -- enable cash payments here
    bank = true, -- enable bank payments here
},

---

Services List

• Each location can have its own list of predefined services or the option to disable the service list and use custom input fields for price and services offered. This is a multi select option if more than 1 option is available and the script will calculate the total costs automatically

• Set enabled to true to use the services list

• Then define services available and their respective costs in the type table

• The name is the text name of the service

• The price is the cost of that service

services = { -- services settings
    enabled = true, -- set to true to change the bill input to use a predefined list of available uses of the bill for example mechanic towed to garage (if set to false the types list can be empty)
    types = { -- define types of services available
        name = 'Custom Billing Option 1', price = 250, },
        {name = 'Custom Billing Option 2', price = 500, },
        {name = 'Custom Billing Option 3', price = 1000, },
        --add more as required
    },
},

---

Finished Config

• Below is an example of a finished config file for an example billing location with commission enabled, minimum job rank required enabled, cash and bank payment types accepted and a services list with defined options and prices

--billing locations
Config.Billing = {
    ['Example Billing Location'] = { -- the key is the location name and must match throughout
        locations = { -- interaction locations
            {
                name = 'example_billing_location_payment_1', -- zone namemust be unique
                enabled = true, debug = true, -- enable zone / debug zone
                coords = vector3(442.65, -980.17, 31.0), -- zone coords
                radius = 0.5, distance = 3.0, -- zone radius / interaction distance
                icon = 'fa-solid fa-cash-register', -- target icon
                label = 'Open Billing', -- target label
                job = Config.CoreSettings.Jobs['Example Billing Location'].name, -- job required to interact
                args = { locationName = 'Example Billing Location', }, -- send locationName args (match the key)
            },
            --add more locations as required
        },
        blip = { -- blip settings
            enabled = true, -- enable blip for this location
            id = 58, colour = 5, scale = 0.6, -- blip id, blip colour and blip scale
            title = 'Example Billing Location Billing', -- blip title
        },
        commission = { -- commission settings
            enabled = true, -- enable player commission
            percent = 20, -- commission percent of total bill value
        },
        access = { -- job access settings
            minRank = true, -- enable job rank check
            rank = 1, -- min job rank required
        },
        progress = { -- progrss Circle settings
            label = 'Sending bill to %s', -- progrssCircle label (the %s is the characters name dont touch that)
            duration = 5, -- time in seconds for progressCircle
            anim = { dict = 'missheistdockssetup1clipboard@base', clip = 'base', flag = 49, }, -- animation settings
            prop = { model = 'prop_notepad_01', bone = 18905, pos = vec3(0.1, 0.02, 0.05), rot = vec3(10.0, 0.0, 0.0), }, -- prop settings
        },
        paymentType = { -- which types of payment can be accepted here
            cash = true, -- enable cash payments here
            bank = true, -- enable bank payments here
        },
        services = { -- services settings
            enabled = true, -- set to true to change the bill input to use a predefined list of available uses of the bill for example mechanic towed to garage (if set to false the types list can be empty)
            types = { -- define types of services available
                {name = 'Custom Billing Option 1', price = 250, },
                {name = 'Custom Billing Option 2', price = 500, },
                {name = 'Custom Billing Option 3', price = 1000, },
                --add more as required
            },
        },
    },
}