Payroll Reference
Detailed guide for pay groups, salary components, salary structures, salary profiles, payroll periods, calculations, approvals, locks, reopen, and adjustments.
Workflow
- ConfigurePayroll admin: Create pay groups, components, salary structures, and salary profiles.
- PrepareHR / Payroll: Review attendance, leave, rosters, corrections, and adjustments.
- CalculatePayroll admin: Run the period, review entries, provenance, gross, deductions, and net.
- CloseApprover: Approve, lock, export, or reopen with reason.
| Stage | Actor | Action | Result |
|---|---|---|---|
| Configure | Payroll admin | Create pay groups, components, salary structures, and salary profiles. | Employees have pay rules. |
| Prepare | HR / Payroll | Review attendance, leave, rosters, corrections, and adjustments. | Payroll inputs are clean. |
| Calculate | Payroll admin | Run the period, review entries, provenance, gross, deductions, and net. | Period results are ready for approval. |
| Close | Approver | Approve, lock, export, or reopen with reason. | The payroll period is controlled and auditable. |
Essential fields
Payroll admin
Pay group and salary component forms
Defines employee pay grouping and reusable earning/deduction components.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Pay group name | Payroll grouping label. | Monthly Staff |
Required. |
| Frequency | How often payroll is processed. | monthly |
Required. |
| Component name/code | Reusable pay item. | House Allowance / HOUSE_ALLOW |
Required. |
| Default value | Default amount or percent. | 15000 |
Can be overridden by profile. |
| Active | Whether selectable. | On |
Archive old components carefully. |
Essential fields
Payroll admin
Salary structure and item forms
Builds a reusable salary template from salary components.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Structure name | Template label. | Operations Monthly |
Required. |
| Pay group | Payroll group this template belongs to. | Monthly Staff |
Required. |
| Component | Earning/deduction item. | Transport Allowance |
Required for item. |
| Amount / percent | How much this item contributes. | 5000 |
Depends on method. |
| Taxable / included flags | Policy treatment. | Taxable yes |
Follow payroll policy. |
Essential fields
Payroll admin
Salary profile form
Assigns a salary structure and custom values to an employee.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Employee | Person being paid. | Hamza Malik |
Required. |
| Structure | Salary template. | Operations Monthly |
Required. |
| Effective date | When profile starts. | 2026-06-01 |
Required. |
| Base salary | Main salary amount. | 85000 |
Required. |
| Profile items | Employee-specific allowances/deductions. | House Allowance 15000 |
Optional overrides. |
| Archive | Stops profile from future use. | Archive |
Historical periods remain. |
Essential fields
Payroll admin / Approver
Payroll period action and adjustment forms
Calculates payroll, adds one-off adjustments, approves, locks, or reopens a payroll period.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Period | Payroll month/week being processed. | June 2026 |
Required. |
| Calculate | Runs payroll calculation. | Calculate period |
Review attendance first. |
| Adjustment employee | Who receives adjustment. | Ali Ahmed |
Required for adjustment. |
| Amount | Adjustment value. | 2500 |
Required. |
| Reason | Why adjustment exists. | Late penalty correction |
Required for audit. |
| Approve / lock / reopen | Period workflow actions. | Lock |
Lock prevents accidental edits. |
Essential table
Database listing
Payroll periods and entries tables
Shows periods, employee payroll entries, adjustments, provenance, and workflow status.
Filters: Period, Employee, Status, Pay group
| Column | What it means | Where it comes from | Example interpretation |
|---|---|---|---|
| Period | Payroll window. | payroll_periods. | June 2026. |
| Employee | Pay entry owner. | payroll_entries employee. | Ali Ahmed. |
| Gross / deductions / net | Payroll amounts. | calculated entries. | Net is final payable after deductions. |
| Attendance basis | Source attendance/leave context. | provenance partial. | 2 late days affected deduction. |
| Adjustment | Manual one-off pay changes. | payroll adjustments. | Bonus 5000. |
| Approval/lock | Workflow state. | period status fields. | Locked means final. |
Available actions
- Open or edit the record when permission allows it.
- Filter the list without losing the current page context.
- Use status badges to decide which item needs attention first.
Full field appendix
Main docs show essential fields only. Open Documentation Coverage for every detected source field, action, column, route hint, controller hint, and test hint.