Assigns business access to a name/email.

Request

POST https://keypay.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 Description
accessType string RelatedUserType

Possible values are:

  • Unrestricted
  • Restricted
email string String
employeeGroups[] array
employeeGroups[].employeeGroupId int32 Int32
employeeGroups[].permissions string UserPermission

Possible values are:

  • ApproveTimesheets
  • ApproveLeaveRequests
  • CreateTimesheets
  • CreateLeaveRequests
  • ViewLeaveRequests
  • ManageRosters
  • ViewRosters
  • ViewShiftCosts
  • ViewExpenses
  • CreateExpenses
  • ApproveExpenses
  • CreateTasks
  • ViewEmployeeDocuments
  • ManageEmployeeDocuments
  • ViewEmployeeQualifications
  • ManageEmployeeQualifications
  • InitiateEmployeeSelfSetup
locationAccess[] array
locationAccess[].filterType string LocationRestrictionFilterTypeEnum

Possible values are:

  • Location
  • LocationOrParents
locationAccess[].locationIds[] array of int32
locationAccess[].permissions string UserPermission

Possible values are:

  • ApproveTimesheets
  • ApproveLeaveRequests
  • CreateTimesheets
  • CreateLeaveRequests
  • ViewLeaveRequests
  • ManageRosters
  • ViewRosters
  • ViewShiftCosts
  • ViewExpenses
  • CreateExpenses
  • ApproveExpenses
  • CreateTasks
  • ViewEmployeeDocuments
  • ManageEmployeeDocuments
  • ViewEmployeeQualifications
  • ManageEmployeeQualifications
  • InitiateEmployeeSelfSetup
name string String
reports object ReportAccessModel
reports.accessType string ReportAccessType

Possible values are:

  • None
  • AllReports
  • SpecificReports
reports.specificReports string ReportEnum

Possible values are:

  • DetailedActivityReport
  • PayRunComparisonReport
  • SuperContributionsReport
  • OrdinaryTimeEarningsReport
  • DeductionsReport
  • PayrollTaxReport
  • PaygReport
  • PayCategoriesReport
  • PayRunAuditReport
  • CostingReport
  • TimesheetReport
  • ExpensesReport
  • PaymentHistoryReport
  • LeaveBalancesReport
  • LeaveLiabilityReport
  • LeaveHistoryReport
  • BirthdayReport
  • EmployeeDetailsReport
  • UnpaidEmployeesReport
  • QualificationsReport
  • EmployeeSatisfactionReport
  • AttendanceReport
  • EmergencyContactsReport
  • EmployerLiabilitiesReport
  • PayRunVarianceReport
  • EmployeeDetailsAuditReport
  • GrossToNetReport
  • LiveView
  • TasksReport
  • ShiftSwappingReport
  • PensionContributionsReport
suppressNotificationEmails boolean Boolean

Response

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

Status code Description Resource
200 OK

OK