Updates permissions for the business document with the specified ID.
PUT https://api.yourpayroll.com.au/api/v2/business/{businessId}/document/{id}
Parameter name | Value | Description | Additional |
---|---|---|---|
id | int32 | Required | |
businessId | string | Required |
The request body takes a complete UpdateDocumentPermissionsModel resource, containing the following writable properties:
{
"employeeGroups": [
"int32"
],
"id": "int32",
"locations": [
"int32"
],
"requiresEmployeeAcknowledgement": "boolean",
"sendInitialNotificationOn": "date-time",
"sendNotificationImmediately": "boolean",
"sendNotificationToEmployee": "boolean",
"sendReminderEveryXDays": "int32",
"visibleToAll": "boolean"
}
Name | Type | Description |
---|---|---|
employeeGroups[] | array of int32 | |
id | int32 | Int32 |
locations[] | array of int32 | |
requiresEmployeeAcknowledgement | boolean | Boolean |
sendInitialNotificationOn | date-time |
Nullable |
sendNotificationImmediately | boolean | Boolean |
sendNotificationToEmployee | boolean | Boolean |
sendReminderEveryXDays | int32 |
Nullable |
visibleToAll | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
DocumentModel |
Powered by DapperDox