Get Suburb

Gets the suburb for the criteria passed in

Request

GET https://api.nzpayroll.co.nz/api/v2/ess/{employeeId}/lookup/suburb

Path parameters

Parameter name Value Description Additional
employeeId string Required

Query parameters

Parameter name Value Description Additional
suburb string Required
state string Required
postCode string Required
countryId string

Response

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

Status code Description Resource
200 OK

OK

 SuburbResult