Skip to content

List payroll runs

GET/payroll/runs

Returns all payroll runs for the tenant, ordered by most recently created. Use to populate the payroll dashboard and select a run for viewing, approving, or marking as paid.

Request

Query parameters

NameTypeRequiredDescription
statusstringNo

Filter runs by lifecycle status.

One of: "draft", "pending_approval", "approved", "paid", "cancelled"

Responses

200 List of payroll runs

Content type application/json, array of object · PayrollRunV1.

FieldTypeRequiredDescription
idintegerNo
namestringNo

Human-readable label for this run (e.g. "April 2026 Payroll").

period_startstring (date)No
period_endstring (date)No
pay_datestring (date)No

Date on which employee payments are to be disbursed.

statusstringNo

One of: "draft", "pending_approval", "approved", "paid", "cancelled"

employee_countinteger, nullableNo

Number of employees included in this run.

gross_totalnumber (float), nullableNo
net_totalnumber (float), nullableNo
currencystringNo

Max length: 3

notesstring, nullableNo
created_atstring (date-time)No

Example

[
  {
    "id": 14,
    "name": "April 2026 Payroll",
    "period_start": "2026-04-01",
    "period_end": "2026-04-30",
    "pay_date": "2026-04-30",
    "status": "pending_approval",
    "employee_count": 48,
    "gross_total": 182400.0,
    "net_total": 141280.0,
    "currency": "GHS",
    "created_at": "2026-04-08T08:00:00Z"
  }
]

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/runs" \
  -H "Accept: application/json"
Loading