Employment Hero Payroll API Reference: Employee Details Report

Generates an employee details report.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/report/employeedetails

Path parameters

Parameter name	Value	Description	Additional
businessId	string		Required

Request body

The request body takes a complete EmployeeDetailsReportRequestModel resource, containing the following writable properties:

{
    "employingEntityId": "int32",
    "includeActive": "boolean",
    "includeInactive": "boolean",
    "locationId": "int32",
    "selectedColumns": [
        "string"
    ]
}

Properties

Name	Type	Description
employingEntityId	int32	Nullable
includeActive	boolean	Boolean
includeInactive	boolean	Boolean
locationId	int32	Int32
selectedColumns[]	array of string

Response

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

Status code	Description	Resource
200	OK OK	JObject