Assigns business access to a name/email.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/access

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accessType": "string",
    "email": "string",
    "employeeGroups": [
        {
            "employeeGroupId": "int32",
            "permissions": "string"
        }
    ],
    "locationAccess": [
        {
            "filterType": "string",
            "locationIds": [
                "int32"
            ],
            "permissions": "string"
        }
    ],
    "name": "string",
    "reports": {
        "accessType": "string",
        "specificReports": "string"
    },
    "suppressNotificationEmails": "boolean"
}

Properties

Name Type
accessType string
email string
employeeGroups[] array
employeeGroups[].employeeGroupId int32
employeeGroups[].permissions string
locationAccess[] array
locationAccess[].filterType string
locationAccess[].locationIds[] array of int32
locationAccess[].permissions string
name string
reports object
reports.accessType string
reports.specificReports string
suppressNotificationEmails boolean

Response

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

Status code Description Resource
200 OK

OK