CreateBusinessAccessModel resource

Methods

  • post - Assign Business Access

Resource

{
    "accessType": "string",
    "email": "string",
    "employeeGroups": [
        {
            "employeeGroupId": "int32",
            "permissions": "string"
        }
    ],
    "kioskAccess": {
        "accessType": "string",
        "kiosks": [
            "int32"
        ],
        "permissions": "string"
    },
    "locationAccess": [
        {
            "filterType": "string",
            "locationIds": [
                "int32"
            ],
            "permissions": "string"
        }
    ],
    "mergeExistingAccess": "boolean",
    "name": "string",
    "payrollAccess": {
        "approveElectronicPayrollLodgement": "boolean",
        "payRunApprovalAccess": "string",
        "payRunCreationAccess": "string",
        "selectedPaySchedulesForPayRunApproval": [
            "int32"
        ],
        "selectedPaySchedulesForPayRunCreation": [
            "int32"
        ],
        "userBusinessRestrictionCount": "int32"
    },
    "reports": {
        "accessType": "string",
        "noReportingRestriction": "boolean",
        "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
  • AddEmployeeFromKiosk
  • ViewEmployeeDetails
  • EditBasicEmployeeDetails
  • EditAllEmployeeDetails
  • ViewTimesheetReports
  • EmployeeNotes
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
  • ViewEmployeeDetails
  • EditBasicEmployeeDetails
  • EditAllEmployeeDetails
  • ViewTimesheetReports
  • EmployeeNotes
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
  • ViewEmployeeDetails
  • EditBasicEmployeeDetails
  • EditAllEmployeeDetails
  • ViewTimesheetReports
  • EmployeeNotes
mergeExistingAccess boolean Boolean
name string String
payrollAccess object PayrollAccessModel
payrollAccess.approveElectronicPayrollLodgement boolean Boolean
payrollAccess.payRunApprovalAccess string Nullable

Possible values are:

  • PayEventApprover
  • PayRunApproverAllSchedules
  • PayRunApproverSelectedSchedules
  • PaymentApproverAllSchedules
  • PaymentApproverSelectedSchedules
  • PayRunCreatorAllSchedules
  • PayRunCreatorSelectedSchedules
payrollAccess.payRunCreationAccess string Nullable

Possible values are:

  • PayEventApprover
  • PayRunApproverAllSchedules
  • PayRunApproverSelectedSchedules
  • PaymentApproverAllSchedules
  • PaymentApproverSelectedSchedules
  • PayRunCreatorAllSchedules
  • PayRunCreatorSelectedSchedules
payrollAccess.selectedPaySchedulesForPayRunApproval[] array of int32
payrollAccess.selectedPaySchedulesForPayRunCreation[] array of int32
payrollAccess.userBusinessRestrictionCount int32 Int32
reports object ReportAccessModel
reports.accessType string ReportAccessType

Possible values are:

  • None
  • AllReports
  • SpecificReports
  • ReportPack
reports.noReportingRestriction boolean Boolean
reports.specificReports string String
suppressNotificationEmails boolean Boolean