Employment Hero Payroll API Reference: Assign Business Access

Assigns business access to a name/email.

Request

POST https://apisg.yourpayroll.io/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"
        }
    ],
    "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	Comma separated list of 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` `RosterTimesheetComparisonReport` `CpfLodgementReport` `WithholdingReport` `EsctRateReport` `JobKeeperEligibilityReport` `EarningsCertificate` `Ir8AReport` `ExcessCpfContributionsReport` `BenefitsInKindReport` `ShareOptionsReport` `Cp39Report` `EAFormReport` `PCB2FormReport` `IrasReport` `IrasLodgementReport` `PayRunExportReport` `JobMakerEligibilityReport` `EpfKwsp6BorangA` `EpfKwsp3Registration` `MyBenefitsInKindReport` `EmployeeBenefitsReport` `BenefitsNiReport` `SocsoForm2` `SocsoFormSip2a` `SocsoForm8a` `PcbWithholdingReport` `SocsoForm3` `IrbFormCp22` `IrbFormCp22a` `CompanyCarsReport` `P11D` `P11Db` `EmployeeCarsReport` `P46Car` `IrbFormCp8d` `DocumentAcknowledgementsReport` `PaymentAndDeductionStatementReport` `UkGenderPayGapDataReport` `Cis300` `Zakat` `EisContributionsReport` `EmployeeLeaveRatesReport` `P11` `P60` `AverageHoursReport` `UkCourtOrderReport` `UkOccupationalPayReport` `EisSocsoCombinedContributionsReport` `P45Report` `CpfOwAndAwReconciliationReport` `PayRunFpsReport` `PortableLongServiceLeaveReport` `UkTaxAndNiBandwidthsReport` `CustomisablePayrollReport` `SuperannuationStaplingDetailsReport` `HmrcInboxReport` `HrdfMonthlyContributionsReport` `CpfApexOverviewReport` `CasualConversionReport`
suppressNotificationEmails	boolean	Boolean

Response

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

Status code	Description	Resource
200	OK OK