Payroll Details

GET /accounting/payroll-details

Group: Accounting › Payroll Details · Operation ID: payrollDetails

Returns a list of payroll runs. Each entry is the run header. Read one run with its lines from GET accounting/payroll-details/:id or POST accounting/payroll-details/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
payrollDetailNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
periodName — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
payrollDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
startDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
endDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
grouping — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isImported — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, payrollDetailNumber, periodName, payrollDate, startDate, endDate, currency, grouping, paymentStatus, lastModifiedDate
Selectable: id, payrollDetailNumber, description, periodName, payrollDate, startDate, endDate, currency, grouping, paymentStatus, isImported, entityName, lastModifiedDate

Response

200 Success

Under data, an array of payrollDetailsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the payroll run.
`payrollDetailNumber`	string or null	no	The payroll run number. Absent until a number has been assigned.
`description`	string or null	no	A description of the payroll run.
`periodName`	string or null	no	The name of the payroll period this run covers, for example '2026-08'.
`payrollDate`	string (date) or null	no	The date the payroll is dated. Format YYYY-MM-DD.
`startDate`	string (date) or null	no	The first day of the period the run covers. Format YYYY-MM-DD.
`endDate`	string (date) or null	no	The last day of the period the run covers. Format YYYY-MM-DD.
`currency`	string or null	no	The currency the run is denominated in. Format ISO 4217, for example 'USD'.
`grouping`	string or null	no	How the payroll run is grouped. Values include 'Employee', 'Department' and 'Multi-level'.
`paymentStatus`	string or null	no	The payment status of the run. Values include 'unpaid', 'partiallyPaid', 'fullyPaid', 'pending', 'notApplicable' and 'voided'.
`isImported`	boolean or null	no	Whether the run was imported from a payroll provider rather than entered by hand.
`entityName`	string or null	no	The name of the legal entity the run belongs to.
`lastModifiedDate`	string (date-time) or null	no	The date and time the payroll run last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error