Field Reference
Complete reference of all fields in the Payroll module.
This page provides a comprehensive reference of every field you may encounter across the Payroll module, including payroll runs, individual payroll items, salary schemas, and related components.
Payroll Run Fields
These fields appear when viewing a payroll run in the Payroll Activities section.
| Field | Description |
|---|---|
| ID | Unique identifier for the payroll run |
| Period | The pay period (month and year) the run covers |
| Status | Current status of the run (see Payroll Status Values below) |
| Total Employees | Number of employees included in the payroll run |
| Gross Pay | Total gross pay across all employees before deductions |
| Total Deductions | Sum of all deductions across all employees |
| Net Pay | Total net pay -- the actual disbursement amount (Gross Pay minus Total Deductions) |
| Created By | The user who created the payroll run |
| Created At | Date and time the run was created |
| Approved By | The user who approved the payroll run (if applicable) |
| Approved At | Date and time the run was approved (if applicable) |
Payroll Item Fields (Per Employee)
Each employee within a payroll run has an individual payroll item with the following fields.
| Field | Description |
|---|---|
| Employee Name | Full name of the employee |
| Department | The department the employee belongs to |
| Base Salary | The employee's base monthly salary |
| Earning Components | List of all earning items (allowances, commission, overtime, bonuses) with individual amounts |
| Deduction Components | List of all deduction items (tax, social security, loan repayments, fines, custom deductions) with individual amounts |
| Gross Pay | Total of base salary plus all earning components |
| Total Deductions | Sum of all deduction components |
| Net Pay | Gross pay minus total deductions -- the amount paid to the employee |
| Status | Status of this individual payroll item (see Payroll Item Status Values below) |
Payroll Status Values
These are the possible statuses for a payroll run. See Payroll Status Workflow for detailed transition rules.
| Status | Description |
|---|---|
| DRAFT | Payroll run has been created and can be freely edited. No payments processed. |
| PENDING | Submitted for approval. Edits are locked until returned to Draft. |
| APPROVED | Approved by an authorized reviewer. Ready for payment processing. |
| PROCESSING | Payments are being processed by the system. |
| COMPLETED | All payments have been processed. Payslips are available. |
| CANCELLED | The payroll run was cancelled. No payments were made. |
Payroll Item Status Values
Individual employee items within a payroll run have their own status tracking.
| Status | Description |
|---|---|
| PENDING | The item has been created and is awaiting review |
| CHECKED | The item has been reviewed for accuracy |
| APPROVED | The item has been approved for payment |
| PAID | Payment has been successfully processed for this employee |
Salary Schema Fields
These fields appear when viewing or editing a salary schema in the Salary Configuration section.
| Field | Description |
|---|---|
| Name | Descriptive name of the schema (e.g., "Driver Standard", "Office Staff Basic") |
| Type | The employee group this schema is designed for: DRIVER, STAFF, SALES, or UNIVERSAL |
| Status | Whether the schema is Active (available for assignment) or Inactive |
| Components | List of earning and deduction components included in the schema |
| Commission Tiers | Revenue-based commission tiers (for driver-type schemas only) |
| Created At | Date and time the schema was created |
Salary Component Fields
Each earning or deduction component within a schema has the following fields.
| Field | Description |
|---|---|
| Name | The name of the component (e.g., "Basic Salary", "Housing Allowance", "Income Tax") |
| Type | How the value is calculated: FIXED (flat amount), PERCENTAGE (proportion of base), or CALCULATED (custom formula) |
| Category | Whether this is an EARNING component (adds to pay) or a DEDUCTION component (reduces pay) |
| Value | The numeric value -- either a fixed amount (e.g., AED 500) or a percentage (e.g., 5%) |
| Priority | The order in which this component is calculated relative to other components |
| Formula | For calculated-type components, the formula used to determine the value |
Commission Tier Fields
Commission tiers define revenue-based commission rates for driver salary schemas.
| Field | Description |
|---|---|
| Min Revenue | The lower bound of the revenue range for this tier (e.g., AED 0, AED 5,001) |
| Max Revenue | The upper bound of the revenue range for this tier (e.g., AED 5,000, AED 10,000) |
| Commission Rate (%) | The percentage of revenue paid as commission within this range |
| Subsidies | List of dynamic subsidies included at this tier level (e.g., fuel subsidy, toll subsidy) |
For a detailed explanation of how commission tiers work and how to configure them, see the Formula Builder page.