Retrieve all PayrollRuns

Retrieves all PayrollRuns within a given Employer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employer Id to retrieve the list of PayrollRuns for.

Query Params
integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 500

The size of the page to be returned

sort
array of strings

Sorting criteria. Prefix the property with - for descending order. Otherwise sort order is ascending. Multiple sort criteria are supported. If no sorting criteria is specified, sorting is not guaranteed however data may be sorted by a default criteria.

sort
filter[status]
array of objects

Filter PayrollRuns by a list of status.

filter[status]
Allowed:
filter[payPeriod.payDate]
array of strings

Filter PayrollRuns by the Pay date. Please refer to the filtering dates format documentation for more information: https://docs.salsa.dev/docs/filtering-and-sorting

filter[payPeriod.payDate]
filter[payPeriod.startDate]
array of strings

Filter PayrollRuns by the period start date. Please refer to the filtering dates format documentation for more information: https://docs.salsa.dev/docs/filtering-and-sorting

filter[payPeriod.startDate]
filter[payPeriod.endDate]
array of strings

Filter PayrollRuns by the period end date. Please refer to the filtering dates format documentation for more information: https://docs.salsa.dev/docs/filtering-and-sorting

filter[payPeriod.endDate]
filter[payPeriod]
array of strings

Filter PayrollRuns by the pay period. Use it with the on operator to determine if a date is within a pay period

filter[payPeriod]
filter[confirmedDate]
array of strings

Filter PayrollRuns by the confirmation date. Please refer to the filtering dates format documentation for more information: https://docs.salsa.dev/docs/filtering-and-sorting

filter[confirmedDate]
Responses

500

Internal Server Error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json