Skip to main content

Payroll

This module enables payroll management. Optionally integrates with LoanManagement for automatic loan repayment deductions.

Features​

  • Salary Structures - Define flexible salary structures with multiple components
  • Payslip Generation - Automated payslip generation with detailed breakdowns
  • Allowances & Deductions - Configure various allowances and deductions
  • Tax Calculations - Built-in tax calculation support
  • Payroll Reports - Comprehensive payroll reporting and analytics

Requirements​

  • Open Core Business Suite v5.0+
  • PHP 8.2+

Optional Dependencies​

ModulePurpose
LoanManagementAutomatic loan repayment deductions

Installation​

Enable via Admin Panel​

  1. Log in as administrator
  2. Navigate to Settings > Addons
  3. Find Payroll and click Enable
  4. Run migrations if prompted

Enable via Command Line​

php artisan module:enable Payroll
php artisan migrate

Usage​

Dashboard​

Navigate to Payroll > Dashboard for an overview of payroll status, recent runs, and key payroll metrics.

All Records​

Navigate to Payroll > All Records to view, generate, and manage payslips:

  1. Select the pay period
  2. Choose employees or departments
  3. Review calculated amounts
  4. Click Generate to create payslips

Components​

Navigate to Payroll > Components to configure salary components such as:

  • Basic salary
  • Allowances (housing, transport, etc.)
  • Other earning types

Each component can be configured with a name, description, calculation method (fixed/percentage), and applicable employee groups.

Modifiers​

Navigate to Payroll > Modifiers to configure deduction types such as:

  • Tax deductions
  • Insurance premiums
  • Loan repayments (with LoanManagement module)

Salary Structures​

Navigate to Payroll > Salary Structures to define flexible salary structures:

  1. Click Add New Structure
  2. Assign components and modifiers to the structure
  3. Define calculation rules
  4. Save the structure

Reports​

Access payroll reports from Payroll > Reports:

  • Payroll Register - Detailed record of all payroll transactions
  • Department Summary - Payroll totals broken down by department
  • Tax Summary - Tax deductions and liabilities overview
  • Employee History - Individual employee payroll history over time

Settings​

Configure payroll settings in Payroll > Settings:

  • General Settings - Payroll prefix, default pay period (weekly, bi-weekly, monthly), payroll start/end day, pay date offset
  • Calculation Settings - Working days per month for daily salary calculations
  • Unpaid Leave (LOP) Settings - Enable/disable LOP deduction, calculation method (working days, calendar days, actual working days), rounding options, weekend/holiday inclusion
  • Feature Settings - Enable/disable expense reimbursement in payroll, enable/disable automatic loan deductions

Changelog: View version history

Last updated on