Payroll API
Manage payroll processing, salary components, loans, advances, and expense claims.
Requires: Payroll module
Payroll Draft Runs
GET /api/payroll/draft-runs
List all payroll draft runs.
POST /api/payroll/draft-runs
Create a new payroll draft for a specific period.
GET /api/payroll/draft-runs/{id}
Get details of a specific payroll draft.
PUT /api/payroll/draft-runs/{id}
Update a payroll draft.
DELETE /api/payroll/draft-runs/{id}
Delete a draft (only if not processed).
POST /api/payroll/draft-runs/{id}/process
Finalize and process a payroll draft. Generates salary slips.
GET /api/payroll/draft-runs/{id}/breakdown
Get complete payroll breakdown for a draft.
GET /api/payroll/draft-runs/{id}/employees/{employeeId}
Get individual employee payroll details within a draft.
Salary Components
GET /api/payroll/salary-components
List all salary components (earnings and deductions).
POST /api/payroll/salary-components
Create a new salary component.
GET/PUT/DELETE /api/payroll/salary-components/{id}
Manage individual salary components.
Employee Payroll Setup
GET /api/payroll/employee-setup/{employeeId}
Get payroll configuration for a specific employee.
My Salary (Employee View)
GET /api/payroll/my-salary
Get the current user’s salary history.
GET /api/payroll/my-salary/{draftId}
Get a specific salary slip for the current user.
Loan & Advance
GET /api/payroll/loan-advances
List loan and advance records.
POST /api/payroll/loan-advances
Submit a new loan/advance application.
GET/PUT/DELETE /api/payroll/loan-advances/{id}
Manage individual loan records.
POST /api/payroll/loan-advances/{id}/defer
Defer a loan installment to the next period.
Expense Claims
GET /api/payroll/expense-claims
List expense claims.
POST /api/payroll/expense-claims
Submit a new expense claim.
GET/PUT/DELETE /api/payroll/expense-claims/{id}
Manage individual expense claims.
WPS Export
GET /api/payroll/wps/{draftId}
Export payroll data in WPS format for the specified draft run.