Get a PayRun

Get
/employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}

See the guides related to this operation below.

Store values

Parameters

string
string
integer
string
integer
(optional)
integer
Zero-based page number, used in conjunction with pageSize (optional)
integer
The number of items per page (optional)
string
The option to filter on a search term (optional)
string
The option to filter pay run entries by negative paid, zero paid and non-zero paid (optional)
string
The option to filter on department code (optional)
string
The option to filter on whether the employee is a starter or leaver (optional)
string
The option to sort by a certain field. Default is Payroll Code (optional)
boolean
Whether to sort in ascending or descending order (optional)
boolean
If set to true, returns rolled back pay run entries. If false, returns all entries. (optional)
Try it

Possible Responses

200 Success PayRun application/json
400 Bad Request
Completing a Pay Run Review the PayRun