Update Employee Document Permissions

Updates permissions for the employee document with the specified ID.

Request

PUT https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/{employeeId}/document

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "id": "int32",
    "requiresEmployeeAcknowledgement": "boolean",
    "sendInitialNotificationOn": "date-time",
    "sendNotificationImmediately": "boolean",
    "sendNotificationToEmployee": "boolean",
    "sendReminderEveryXDays": "int32",
    "visible": "boolean"
}

Properties

Name Type Description
id int32 Int32
requiresEmployeeAcknowledgement boolean Boolean
sendInitialNotificationOn date-time Nullable
sendNotificationImmediately boolean Boolean
sendNotificationToEmployee boolean Boolean
sendReminderEveryXDays int32 Nullable
visible boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 EmployeeDocumentModel