Skip to content

Get payroll run

GET/payroll/runs/{id}

Returns full detail for a specific payroll run including totals, employee count, and approval history.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

The numeric ID of the payroll run.

Responses

200 Payroll run detail

Content type application/json, 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

404 Payroll run not found

Example request

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