Update Employee Portal Settings

Updates the business employee portal settings

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "allowEmployeeBankAccountSelfService": "boolean",
    "allowEmployeeExpensesSelfService": "boolean",
    "allowEmployeeKiwiSaverSelfService": "boolean",
    "allowEmployeeLeaveSelfService": "boolean",
    "allowEmployeeOverrideTaxCodes": "boolean",
    "allowEmployeeSatisfactionSurvey": "boolean",
    "allowEmployeeSelfEditing": "boolean",
    "allowEmployeeShiftSelection": "boolean",
    "allowEmployeeToSetUnavailability": "boolean",
    "allowEmployeesToUploadProfilePicture": "boolean",
    "allowEmployeesToViewAllApprovedLeave": "boolean",
    "clockOffReminderNotificationMinutes": "int32",
    "clockOffWindowMinutes": "int32",
    "clockOnReminderNotificationMinutes": "int32",
    "clockOnWindowMinutes": "int32",
    "enableWorkZoneClockOn": "boolean",
    "requirePhoto": "boolean",
    "sendEmployeeDetailsUpdateNotifications": "boolean",
    "showPayDaysInEmployeeCalendar": "boolean",
    "timesheetSetting": "string",
    "unavailabilityCutOff": "int32"
}

Properties

Name Type Description
allowEmployeeBankAccountSelfService boolean Boolean
allowEmployeeExpensesSelfService boolean Boolean
allowEmployeeKiwiSaverSelfService boolean Boolean
allowEmployeeLeaveSelfService boolean Boolean
allowEmployeeOverrideTaxCodes boolean Boolean
allowEmployeeSatisfactionSurvey boolean Boolean
allowEmployeeSelfEditing boolean Boolean
allowEmployeeShiftSelection boolean Boolean
allowEmployeeToSetUnavailability boolean Boolean
allowEmployeesToUploadProfilePicture boolean Boolean
allowEmployeesToViewAllApprovedLeave boolean Boolean
clockOffReminderNotificationMinutes int32 Nullable
clockOffWindowMinutes int32 Nullable
clockOnReminderNotificationMinutes int32 Nullable
clockOnWindowMinutes int32 Nullable
enableWorkZoneClockOn boolean Boolean
requirePhoto boolean Boolean
sendEmployeeDetailsUpdateNotifications boolean Boolean
showPayDaysInEmployeeCalendar boolean Boolean
timesheetSetting string ESSTimesheetSettingModelEnum

Possible values are:

  • Disabled
  • ReadOnly
  • ReadWrite
  • EditKiosk
  • EditWorkZoneClockOnOff
  • EditKioskOrWorkZoneClockOnOff
  • Enabled
unavailabilityCutOff int32 Int32

Response

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

Status code Description Resource
200 OK

OK

 NzEmployeePortalSettingsModel