Initiate Employee Self Setup

Initiate the Self Setup process for an Employee. If the employee has an existing employee record, the id should be specified. If the Email and Mobile provided are not the same as those on the employee record, they will be updated. If the employee does not yet have an employee record do not specify an id, one will be created with the details provided.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employeeonboarding/initiateselfservice

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "email": "string",
    "emergencyContactDetailsRequired": "boolean",
    "employingEntityId": "int32",
    "firstName": "string",
    "id": "int32",
    "mobile": "string",
    "onboardingStarterType": "string",
    "qualificationsRequired": "boolean",
    "surname": "string",
    "title": "int32"
}

Properties

Name Type Description
email string String
emergencyContactDetailsRequired boolean Boolean
employingEntityId int32 Nullable
firstName string String
id int32 Nullable
mobile string String
onboardingStarterType string Nullable

Possible values are:

  • NewStarterKiwiSaverEligible
  • NewStarterKiwiSaverIneligible
  • ExistingEmployeeKiwiStarterEligible
  • ExistingEmployeeKiwiStarterIneligible
qualificationsRequired boolean Boolean
surname string String
title int32 Nullable

Response

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

Status code Description Resource
200 OK

OK