List Employers (filtered and paged)

Get
/bureau/employers/paged

Returns a filtered, sorted, and paged set of bureau employer rows for the advanced bureau dashboard.
Note: an entry is returned for each PaySchedule.

Store values

Parameters

string
The Id of the Processor (User) you want to restrict the list to. (optional)
string
Restricts results to the specified tax year. (optional)
string
Filters by employer name, id, alternative id, or PAYE reference (minimum 3 characters). (optional)
boolean
When set, only rows with or without approvals enabled are returned. (optional)
integer
Zero-based page index. (optional)
integer
Number of rows per page. (optional)
string
The column to sort by. Defaults to Name. (optional)
boolean
True to sort descending. Defaults to ascending. Rows with no value for the sorted column are always listed last. (optional)
string
Filters rows by deadline urgency (Overdue, Due today, Due soon). (optional)
string
Filters rows by displayed current payroll stage. (optional)
string
Filters rows by pay schedule frequency. (optional)
string
Filters rows by aggregate compliance status. (optional)
Try it

Possible Responses

200 Success Contract.BureauEmployerPagedResponse application/json