Reference
Payroll & Payslips
Run payroll, list payroll runs, fetch payslips. PAYE computed on the 2025 Nigerian tax bands.
Running payroll computes PAYE, pension, NHF, and NHIS deductions per employee, generates payslips, and posts the combined journal entry to your ledger. PAYE follows the 2025 Nigerian Tax Act bands.
Run payroll
POST
/v1/payroll/runComputes and posts payroll for a month. Creates payslips for every active employee.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
month | integer | yes | 1–12. |
year | integer | yes | Four digits. |
paymentDate | ISO 8601 | no | When salaries will be paid. Defaults to the 28th of the period. |
notes | string | no | Shown on the payroll run. |
Response — 201
{
"success": true,
"data": {
"payrollRunId": "pr_abc",
"month": 4,
"year": 2026,
"employeeCount": 12,
"totals": {
"grossSalaryKobo": 125000000,
"payeKobo": 18750000,
"pensionEmployeeKobo": 10000000,
"nhfKobo": 3125000,
"nhisKobo": 0,
"netSalaryKobo": 93125000,
"employerPensionKobo": 12500000
},
"payslipCount": 12,
"status": "approved",
"createdAt": "2026-04-17T10:30:00.000Z"
}
}List payroll runs
GET
/v1/payroll/runsHistorical runs, newest first.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
businessId | string | yes | |
limit | integer | no | Default 50, max 100. |
year | integer | no | Filter to a single year. |
List payslips
GET
/v1/payslipsLists payslips. Filter by employee or period.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
businessId | string | yes | |
employeeId | string | no | |
month, year | integer | no | Filter to a specific period. |
limit | integer | no | Default 50, max 100. |
Get a single payslip
GET
/v1/payslips/{id}Fetches one payslip with full earnings and deductions breakdown.
Response — 200
{
"success": true,
"data": {
"id": "ps_abc",
"employeeId": "emp_001",
"employeeName": "Funke Oladele",
"month": 4,
"year": 2026,
"grossSalaryKobo": 10000000,
"earnings": {
"basic": 7500000,
"housing": 1500000,
"transport": 1000000
},
"deductions": {
"payeKobo": 1500000,
"pensionEmployeeKobo": 800000,
"nhfKobo": 250000,
"nhisKobo": 0
},
"netSalaryKobo": 7450000,
"netSalary": 74500
}
}To generate the payslip PDF, use the documents module.
Related endpoints
Reference index
Back to all modules