List Employees

This endpoint returns the unstructured employee details for all matching employees.

See also: List basic details for employees (which is much more efficient if that is all the information that is required)

This operation supports OData queries (only $filter, $orderby, $top, $skip).

Request

GET https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/unstructured

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
filter.payScheduleId int32
filter.locationId int32

Request headers

Parameter name Value Description Additional
options

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 NzUnstructuredEmployeeModel