📃Exports

All client and server exports

CLIENT

OpenBossMenu

Opens the boss menu for the specified organization type.

Parameters:

• type (string, optional): Type of organization - 'job' or 'gang' (default: 'job')

Returns:

• void

Example:

-- Open job boss menu
exports['zat-bossmenu']:OpenBossMenu('job')

-- Open gang boss menu
exports['zat-bossmenu']:OpenBossMenu('gang')

-- Open job menu (default)
exports['zat-bossmenu']:OpenBossMenu()

Use Case:

• Adding custom menu access points in other resources

• Creating keyboard shortcuts for specific organizations

• Integration with job-specific scripts

---

OpenGangMenu

Convenience function to open the gang boss menu.

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:OpenGangMenu()

Note: Equivalent to OpenBossMenu('gang')

---

OpenJobMenu

Convenience function to open the job boss menu.

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:OpenJobMenu()

Note: Equivalent to OpenBossMenu('job')

---

CloseBossMenu

Closes the currently open boss menu.

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:CloseBossMenu()

Use Case:

• Programmatically closing the menu in response to other events

• Menu cleanup in resource transitions

---

OpenAdminUI

Opens the admin control panel interface.

Parameters:

• None

Returns:

• void

Example:

-- Usually restricted to admin players
exports['zat-bossmenu']:OpenAdminUI()

Note: Server-side permission checks still apply

---

CloseAdminUI

Closes the admin control panel.

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:CloseAdminUI()

---

ToggleDuty

Toggles duty status for the player (framework-specific).

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:ToggleDuty()

Framework Support:

• QB-Core: Uses QBCore:ToggleDuty event

• ESX: Uses ESX:ToggleDuty event

• Other frameworks: May need custom implementation

Use Case:

• Custom duty toggle buttons in other UIs

• Job start/end systems

• Payroll tracking systems

---

ToggleGangDuty

Toggles duty status for gang members.

Parameters:

• None

Returns:

• void

Example:

exports['zat-bossmenu']:ToggleGangDuty()

Use Case:

• Custom duty toggles in gang scripts

• Gang activity tracking

• Permission-based access systems for gangs

SERVER

GetJobFunds

Get the current funds of a job/organization.

Parameters:

• jobName (string): Name of the job/organization

• default (number, optional): Default value if no funds found (default: 0)

Returns:

• number: Current funds amount

Example:

local policeFunds = exports['zat-bossmenu']:GetJobFunds('police')
local ambulanceFunds = exports['zat-bossmenu']:GetJobFunds('ambulance', 1000)

---

UpdateJobFunds

Update (add/remove) funds for a job/organization.

Parameters:

• jobName (string): Name of the job/organization

• amount (number): Amount to add/remove (positive for deposit, negative for withdraw)

• changeType (string): Type of transaction - 'deposit', 'withdraw', or 'bonus'

• reason (string, optional): Reason for the transaction

Returns:

• boolean: Success status

Example:

-- Deposit 1000 for police payroll
exports['zat-bossmenu']:UpdateJobFunds('police', 1000, 'deposit', 'Monthly payroll')

-- Withdraw 500 for equipment purchase
exports['zat-bossmenu']:UpdateJobFunds('ambulance', 500, 'withdraw', 'Medical equipment')

-- Give bonus to employees
exports['zat-bossmenu']:UpdateJobFunds('mechanic', 200, 'bonus', 'Performance bonus')

---

SetJobFunds

Set the funds of a job/organization to a specific amount.

Parameters:

• src (number): Player server ID (for logging)

• jobName (string): Name of the job/organization

• amount (number): New funds amount

Returns:

• boolean: Success status

Example:

-- Set police funds to 50000
exports['zat-bossmenu']:SetJobFunds(source, 'police', 50000)

---

GetCompanyFunds

Alias for GetJobFunds - provides backward compatibility.

Example:

local funds = exports['zat-bossmenu']:GetCompanyFunds('police')

---

UpdateCompanyFunds(jobName, amount, changeType, [reason]) (Alias)

Alias for UpdateJobFunds - provides backward compatibility.

---

GetGangFunds

Get the current funds of a gang.

Parameters:

• gangName (string): Name of the gang

• default (number, optional): Default value if no funds found (default: 0)

Returns:

• number: Current funds amount

Example:

local lostmcFunds = exports['zat-bossmenu']:GetGangFunds('lostmc')
local vagosFunds = exports['zat-bossmenu']:GetGangFunds('vagos', 5000)

---

UpdateGangFunds

Update (add/remove) funds for a gang.

Parameters:

• gangName (string): Name of the gang

• amount (number): Amount to add/remove

• changeType (string): Type of transaction - 'deposit', 'withdraw', or 'bonus'

• reason (string, optional): Reason for the transaction

Returns:

• boolean: Success status

Example:

-- Gang made money from activity
exports['zat-bossmenu']:UpdateGangFunds('ballas', 1500, 'deposit', 'Street sales')

-- Gang purchased weapons
exports['zat-bossmenu']:UpdateGangFunds('families', 800, 'withdraw', 'Weapon purchase')

---

SetGangFunds

Set the funds of a gang to a specific amount.

Parameters:

• src (number): Player server ID (for logging)

• gangName (string): Name of the gang

• amount (number): New funds amount

Returns:

• boolean: Success status

Example:

-- Reset gang funds to 10000
exports['zat-bossmenu']:SetGangFunds(source, 'lostmc', 10000)

---

GetBankingSystem

Get the currently active banking system.

Returns:

• string: Name of the active banking system

  • 'qb-banking'

  • 'esx_addonaccount'

  • 'okokBanking'

  • 'qs-banking'

  • 'default'

Example:

local bankingSystem = exports['zat-bossmenu']:GetBankingSystem()
if bankingSystem == 'qb-banking' then
    -- QB-specific logic
end

---

GetSupportedBankingSystems

Get a list of all supported banking systems.

Returns:

• table: Array of supported banking system names

Example:

local supportedSystems = exports['zat-bossmenu']:GetSupportedBankingSystems()
-- Returns: {'qb-banking', 'esx_addonaccount', 'okokBanking', 'qs-banking', 'default'}

AddExternalTransaction

Logs an external financial transaction for an organization.

Parameters:

• jobname (string): Name of the organization (job or gang)

• amount (number): Transaction amount (must be positive)

• reason (string): Description/reason for the transaction

• type (string): Transaction type - 'deposit' or 'withdraw'

Returns:

• void

Example:

-- Log a deposit to police organization
exports['zat-bossmenu']:AddExternalTransaction(
    'police', 
    5000, 
    'City funding allocation', 
    'deposit'
)

-- Log a withdrawal from mechanic organization
exports['zat-bossmenu']:AddExternalTransaction(
    'mechanic',
    1000,
    'Tool purchase invoice #456',
    'withdraw'
)

Use Case:

• Integrating external banking systems

• Automated payment processing

• Third-party business systems

• Audit and compliance logging