Methods

  • get - Get User Business Access
  • get - List All Business Access Users

Resource

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

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
  • AddEmployeeFromKiosk
kioskAccess object KioskAccessModel
kioskAccess.accessType string KioskAccessType

Possible values are:

  • None
  • AllKiosks
  • SpecificKiosks
kioskAccess.kiosks[] array of int32
kioskAccess.permissions string UserPermission

Possible values are:

  • ApproveTimesheets
  • ApproveLeaveRequests
  • CreateTimesheets
  • CreateLeaveRequests
  • ViewLeaveRequests
  • ManageRosters
  • ViewRosters
  • ViewShiftCosts
  • ViewExpenses
  • CreateExpenses
  • ApproveExpenses
  • CreateTasks
  • ViewEmployeeDocuments
  • ManageEmployeeDocuments
  • ViewEmployeeQualifications
  • ManageEmployeeQualifications
  • InitiateEmployeeSelfSetup
  • AddEmployeeFromKiosk
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
  • AddEmployeeFromKiosk
name string String
reports object ReportAccessModel
reports.accessType string ReportAccessType

Possible values are:

  • None
  • AllReports
  • SpecificReports
  • ReportPack
reports.noReportingRestriction boolean Boolean
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
  • EmployerPaymentSummaryReport
  • PayRunInclusionsReport
  • P32Report
  • PaySlipReport
  • PaymentFileReport
  • JournalReport
  • IrdEmployeeDetailsReport
  • PayDayFilingReport
  • KiwiSaverReport
  • PayeReport
  • KiwiSaverEmploymentDetailsReport
  • EmployerDeductions