Employment Hero Payroll API Reference: Specification summary

Detailed Activity Report as Excel

Description	HTTP Request
Detailed Activity Report as Excel	GET /api/v2/business/{businessId}/report/detailedactivity/xlsx

Create a new direct billing user

Description	HTTP Request
Create a new direct billing user	POST /api/v2/user/create-direct-account

Update roster shift

Description	HTTP Request
Update roster shift	PUT /api/v2/business/{businessId}/rostershift/{rosterShiftId}

Pay Run Audit Report

Description	HTTP Request
Pay Run Audit Report	GET /api/v2/business/{businessId}/report/payrunaudit/{payRunId}/xlsx

List Tiered Leave Allowance Templates

Description	HTTP Request
Create Tiered Leave Allowance Template	POST /api/v2/business/{businessId}/tieredleaveallowancetemplate
List Tiered Leave Allowance Templates	GET /api/v2/business/{businessId}/tieredleaveallowancetemplate

List Leave Categories

Description	HTTP Request
List Leave Categories	GET /api/v2/business/{businessId}/manager/leaverequest/categories

List White Labels

Description	HTTP Request
List White Labels	GET /api/v2/whitelabel

List Employer Liabilities

Description	HTTP Request
Create Employer Liabilities	POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Delete Employer Liability	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
List Employer Liabilities	GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities

Description

HTTP Request

Create Employer Liabilities

POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities

Delete Employer Liability

DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities

List Employer Liabilities

GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities

List Addresses

Description	HTTP Request
List Addresses	GET /api/v2/ess/{employeeId}/lookup/addresses/{suburbId}

List Business Templates

Description	HTTP Request
List Business Templates	GET /api/v2/brand/{brandId}/business-templates

Get Expense Request by ID

Description	HTTP Request
Delete Expense Request	DELETE /api/v2/ess/{employeeId}/expense/{expenseRequestId}
Get Expense Request by ID	GET /api/v2/ess/{employeeId}/expense/{expenseRequestId}
Update Expense Request	PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId}

Single Sign On

Description	HTTP Request
Single Sign On	POST /api/v2/singlesignon

List Deduction Categories

Description	HTTP Request
Create Deduction Category	POST /api/v2/business/{businessId}/deductioncategory
List Deduction Categories	GET /api/v2/business/{businessId}/deductioncategory

Get standard hours for employee

Description	HTTP Request
Get standard hours for employee	GET /api/v2/business/{businessId}/employee/{employeeId}/standardhours
Set standard hours for employee	PUT /api/v2/business/{businessId}/employee/{employeeId}/standardhours

Active Employees Report

Description	HTTP Request
Active Employees Report	GET /api/v2/brand/{brandId}/reports/activeemployees

Get Brand Invoice By ID

Description	HTTP Request
Get Brand Invoice By ID	GET /api/v2/brand/{brandId}/Invoice/{id}

Upload Attachment to Leave Request

Description	HTTP Request
Delete Attachment from Leave Request	DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment
Upload Attachment to Leave Request	PUT /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment

Get Location Specific Chart of Accounts

Description	HTTP Request
Delete Location Specific Chart of Accounts	DELETE /api/v2/business/{businessId}/chartofaccounts/location/{locationId}
Get Location Specific Chart of Accounts	GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}
Update Location Specific Chart of Accounts	POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}

Description

HTTP Request

Delete Location Specific Chart of Accounts

DELETE /api/v2/business/{businessId}/chartofaccounts/location/{locationId}

Get Location Specific Chart of Accounts

GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}

Update Location Specific Chart of Accounts

POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}

Get Business Invoices

Description	HTTP Request
Get Business Invoices	GET /api/v2/business/{businessId}/Invoice

List Businesses

Description	HTTP Request
Create New Business	POST /api/v2/business
List Businesses	GET /api/v2/business
Update Business Details	PUT /api/v2/business

List Resellers

Description	HTTP Request
List Resellers	GET /api/v2/reseller

Get Leave Category by ID

Description	HTTP Request
Delete Leave Category	DELETE /api/v2/business/{businessId}/leavecategory/{id}
Get Leave Category by ID	GET /api/v2/business/{businessId}/leavecategory/{id}
Update Leave Category	PUT /api/v2/business/{businessId}/leavecategory/{id}

Unlock Pay Run

Description	HTTP Request
Unlock Pay Run	POST /api/v2/business/{businessId}/payrun/{payRunId}/unlock

Find Matching Clock Off Roster Shift

Description	HTTP Request
Find Matching Clock Off Roster Shift	GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockoff

Start Break

Description	HTTP Request
Start Break	POST /api/v2/ess/{employeeId}/timeandattendance/startbreak

Get Brand Label by ID

Description	HTTP Request
Get Brand Label by ID	GET /api/v2/brand/{id}

Get User Business Access

Description	HTTP Request
Get User Business Access	GET /api/v2/business/{businessId}/access/user

Start Payment Approval Process

Description	HTTP Request
Start Payment Approval Process	GET /api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start

Bulk insert Journal Accounts

Description	HTTP Request
Bulk insert Journal Accounts	POST /api/v2/business/{businessId}/accounts/bulk

Upload attachment to qualification

Description	HTTP Request
Upload attachment to qualification	PUT /api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment

Get Shift Notes

Description	HTTP Request
Add Note to Shift	POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes
Get Shift Notes	GET /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes

List Employee Locations

Description	HTTP Request
List Employee Locations	GET /api/v2/business/{businessId}/manager/employee/{employeeId}/location

Get expenses reference data

Description	HTTP Request
Get expenses reference data	GET /api/v2/business/{businessId}/manager/{employeeId}/expense/reference

Clock Out Employee

Description	HTTP Request
Clock Out Employee	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockoff

List payment files

Description	HTTP Request
Create payment file record	POST /api/v2/business/{businessId}/paymentfiles
List payment files	GET /api/v2/business/{businessId}/paymentfiles

Get Pay Slip by Pay Run ID

Description	HTTP Request
Get Pay Slip by Pay Run ID	GET /api/v2/ess/{employeeId}/document/payslip/{payrunId}

Get Employee Expense Category by ID

Description	HTTP Request
Delete Employee Expense Category	DELETE /api/v2/business/{businessId}/employeeexpensecategory/{id}
Get Employee Expense Category by ID	GET /api/v2/business/{businessId}/employeeexpensecategory/{id}
Update Employee Expense Category	PUT /api/v2/business/{businessId}/employeeexpensecategory/{id}

Get Shift Conditions

Description	HTTP Request
Get Shift Conditions	GET /api/v2/ess/{employeeId}/lookup/shiftcondition

Get Pay Run Totals by Employee ID

Description	HTTP Request
Get Pay Run Totals by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}

List Employee Locations

Description	HTTP Request
List Employee Locations	GET /api/v2/business/{businessId}/manager/location

List countries

Description	HTTP Request
List countries	GET /api/v2/lookupdata/countries

Get Reseller Invoice By ID

Description	HTTP Request
Get Reseller Invoice By ID	GET /api/v2/reseller/{resellerId}/Invoice/{id}

Get Leave Balances

Description	HTTP Request
Get Leave Balances	GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/balances

Clock In Employee

Description	HTTP Request
Clock In Employee	POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockon

Upload Attachment to Expense Request

Description	HTTP Request
Upload Attachment to Expense Request	PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId}/attachment

Get Roster Shift by ID

Description	HTTP Request
Get Roster Shift by ID	GET /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}
Update roster shift	PUT /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}

Get Titles

Description	HTTP Request
Get Titles	GET /api/v2/ess/{employeeId}/lookup/title

Estimate Leave Hours

Description	HTTP Request
Estimate Leave Hours	GET /api/v2/ess/{employeeId}/leave/estimate

Get Shift Costings for Employee

Description	HTTP Request
Get Shift Costings for Employee	POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftcosting

Decline Roster Shift

Description	HTTP Request
Decline Roster Shift	POST /api/v2/ess/{employeeId}/shift/{rosterShiftId}/decline

Decline Shift Swap

Description	HTTP Request
Decline Shift Swap	POST /api/v2/ess/{employeeId}/shift/{rosterShiftId}/swap/decline

List Work Types

Description	HTTP Request
Create Work Type	POST /api/v2/business/{businessId}/worktype
List Work Types	GET /api/v2/business/{businessId}/worktype

Get Leave Accruals

Description	HTTP Request
Delete Leave Accrual	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Get Leave Accruals	GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Save Leave Accruals	POST /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued

List Timesheet Employees

Description	HTTP Request
List Timesheet Employees	GET /api/v2/business/{businessId}/manager/timesheet/employees

Gross To Net Report as Excel

Description	HTTP Request
Gross To Net Report as Excel	GET /api/v2/business/{businessId}/report/grosstonet/xlsx

Get Business Document Details

Description	HTTP Request
Delete Business Document	DELETE /api/v2/business/{businessId}/document/{id}
Get Business Document Details	GET /api/v2/business/{businessId}/document/{id}
Update Business Document Permissions	PUT /api/v2/business/{businessId}/document/{id}

Clone Pay Condition Rule Set

Description	HTTP Request
Clone Pay Condition Rule Set	POST /api/v2/business/{businessId}/payconditionruleset/clone

List Expense Requests

Description	HTTP Request
Create Expense Request	POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest
List Expense Requests	GET /api/v2/business/{businessId}/employee/{employeeId}/expenserequest

Get the initial tax year

Description	HTTP Request
Change the tax year	POST /api/v2/business/{businessId}/initialfinancialyear
Get the initial tax year	GET /api/v2/business/{businessId}/initialfinancialyear

Get Employee Expense by ID

Description

HTTP Request

Delete Employee Expense

DELETE /api/v2/business/{businessId}/employee/{employeeId}/expense/{id}

Get Employee Expense by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/expense/{id}

Update Employee Expense

PUT /api/v2/business/{businessId}/employee/{employeeId}/expense/{id}

List Employer liabilities

Description	HTTP Request
Create Employer liability	POST /api/v2/business/{businessId}/employee/{employeeId}/employerliability
List Employer liabilities	GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability

Assign Leave Allowance Template

Description	HTTP Request
Assign Leave Allowance Template	POST /api/v2/business/{businessId}/employee/{employeeId}/leaveallowancetemplate/assign/{leaveAllowanceTemplateId}

Bulk Cancel Roster Shift Swaps

Description	HTTP Request
Bulk Cancel Roster Shift Swaps	POST /api/v2/ess/{employeeId}/shift/swap/cancel

Find Matching Clock On Roster Shift

Description	HTTP Request
Find Matching Clock On Roster Shift	GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockon

Get Leave Accruals for Employee

Description	HTTP Request
Get Leave Accruals for Employee	GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId}

Add Complete Shift for Employee

Description	HTTP Request
Add Complete Shift for Employee	POST /api/v2/business/{businessId}/kiosk/{kioskId}/addshift

Get Leave Allowances for Employee

Description	HTTP Request
Get Leave Allowances for Employee	GET /api/v2/business/{businessId}/leaveallowances/{employeeId}

List Business Document Details

Description	HTTP Request
Create Business Document	POST /api/v2/business/{businessId}/document
List Business Document Details	GET /api/v2/business/{businessId}/document

Set Business Billing Plan

Description	HTTP Request
Set Business Billing Plan	POST /api/v2/business/{businessId}/subscription/setbillingplan

List Employee Expenses

Description	HTTP Request
Create Employee Expense	POST /api/v2/business/{businessId}/employee/{employeeId}/expense
List Employee Expenses	GET /api/v2/business/{businessId}/employee/{employeeId}/expense

Cancel Business

Description	HTTP Request
Cancel Business	DELETE /api/v2/brand/{brandId}/business/{businessId}/cancel

OAuth Token

Description	HTTP Request
OAuth Token	POST /oauth/token

Get Qualification by ID

Description	HTTP Request
Delete Qualification	DELETE /api/v2/business/{businessId}/qualification/{id}
Get Qualification by ID	GET /api/v2/business/{businessId}/qualification/{id}
Update Qualification	PUT /api/v2/business/{businessId}/qualification/{id}

Register Device Token

Description	HTTP Request
Register Device Token	POST /api/v2/ess/devicetoken/register

Start Break

Description	HTTP Request
Start Break	POST /api/v2/business/{businessId}/kiosk/{kioskId}/startbreak

Get Employee basic details by ID

Description	HTTP Request
Get Employee basic details by ID	GET /api/v2/business/{businessId}/employee/{employeeId}/details

List Entitlements

Description	HTTP Request
List Entitlements	GET /api/v2/business/{businessId}/entitlements

Pay Categories Report

Description	HTTP Request
Pay Categories Report	GET /api/v2/business/{businessId}/report/paycategories

Get Chart of Accounts

Description	HTTP Request
Get Chart of Accounts	GET /api/v2/business/{businessId}/chartofaccounts
Update Chart of Accounts	POST /api/v2/business/{businessId}/chartofaccounts

Get timesheet line

Description	HTTP Request
Delete timesheet line	DELETE /api/v2/business/{businessId}/timesheet/{timesheetLineId}
Get timesheet line	GET /api/v2/business/{businessId}/timesheet/{timesheetLineId}
Update timesheet line	PUT /api/v2/business/{businessId}/timesheet/{timesheetLineId}

List Deductions

Description	HTTP Request
Create Deductions	POST /api/v2/business/{businessId}/payrun/{payRunId}/deductions
Delete Deduction	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/deductions
List Deductions	GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions

Get Next Pay Date

Description	HTTP Request
Get Next Pay Date	GET /api/v2/business/{businessId}/payschedule/{payScheduleId}/nextpaydate

Get Opening Balances

Description	HTTP Request
Get Opening Balances	GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances
Set Opening Balances	POST /api/v2/business/{businessId}/employee/{employeeId}/openingbalances

Approve Timesheet

Description	HTTP Request
Approve Timesheet	POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/approve

Employee Has Access

Description	HTTP Request
Employee Has Access	GET /api/v2/business/{businessId}/kiosk/hasaccess/{employeeId}

Get List of Locations

Description	HTTP Request
Get List of Locations	GET /api/v2/business/{businessId}/manager/locations

Get Pay Category by ID

Description	HTTP Request
Delete Pay Category	DELETE /api/v2/business/{businessId}/paycategory/{id}
Get Pay Category by ID	GET /api/v2/business/{businessId}/paycategory/{id}
Update Pay Category	PUT /api/v2/business/{businessId}/paycategory/{id}

Get Reseller Invoice PDF By ID

Description	HTTP Request
Get Reseller Invoice PDF By ID	GET /api/v2/reseller/{resellerId}/Invoice/{id}/pdf

Prepare Leave Liability report

Description	HTTP Request
Prepare Leave Liability report	POST /api/v2/business/{businessId}/report/leaveliability/preparation

Get Shift Notes

Description	HTTP Request
Add Note to Shift	POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes
Get Shift Notes	GET /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes

Reject Timesheet

Description	HTTP Request
Reject Timesheet	POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/reject

Revoke Kiosk Access

Description	HTTP Request
Revoke Kiosk Access	POST /api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId}

Update kiosk timesheet line

Description	HTTP Request
Update kiosk timesheet line	PUT /api/v2/business/{businessId}/manager/kiosk/timesheet/{timesheetLineId}

Single Sign On

Description	HTTP Request
Single Sign On	POST /api/v2/business/{businessId}/employee/{employeeId}/singlesignon

Detailed Activity Report

Description	HTTP Request
Detailed Activity Report	GET /api/v2/business/{businessId}/report/detailedactivity

Get unavailability by ID

Description	HTTP Request
Delete Unavailability	DELETE /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}
Get unavailability by ID	GET /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}
Update Unavailability	PUT /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}

Get Kiosk by ID

Description	HTTP Request
Delete Kiosk	DELETE /api/v2/business/{businessId}/kiosk/{id}
Get Kiosk by ID	GET /api/v2/business/{businessId}/kiosk/{id}
Update Kiosk	PUT /api/v2/business/{businessId}/kiosk/{id}

Shifts

Description	HTTP Request
Shifts	POST /api/v2/business/{businessId}/kiosk/shifts

Get Employer Liability Category

Description	HTTP Request
Delete Employer Liability Category	DELETE /api/v2/business/{businessId}/employerliabilitycategory/{id}
Get Employer Liability Category	GET /api/v2/business/{businessId}/employerliabilitycategory/{id}
Update Employer Liability Category	PUT /api/v2/business/{businessId}/employerliabilitycategory/{id}

Get Employee By External ID

Description	HTTP Request
Get Employee By External ID	GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}

Get Kiosks

Description	HTTP Request
Get Kiosks	GET /api/v2/business/{businessId}/manager/kiosk

List Employee Tax Relief Adjustments

Description	HTTP Request
Create Employee Tax Relief Adjustment	POST /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment
List Employee Tax Relief Adjustments	GET /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment

List Employee Groups

Description	HTTP Request
Create Employee Group	POST /api/v2/business/{businessId}/employeegroup
List Employee Groups	GET /api/v2/business/{businessId}/employeegroup

Reapply Leave Allowance Template

Description	HTTP Request
Reapply Leave Allowance Template	POST /api/v2/business/{businessId}/leaveallowancetemplate/reapply/{id}

Get Employee Portal Settings

Description	HTTP Request
Get Employee Portal Settings	GET /api/v2/business/{businessId}/employeeportalsettings
Update Employee Portal Settings	POST /api/v2/business/{businessId}/employeeportalsettings

Get Leave Allowance Template by ID

Description	HTTP Request
Delete Leave Allowance Template	DELETE /api/v2/business/{businessId}/leaveallowancetemplate/{id}
Get Leave Allowance Template by ID	GET /api/v2/business/{businessId}/leaveallowancetemplate/{id}
Update Leave Allowance Template	PUT /api/v2/business/{businessId}/leaveallowancetemplate/{id}

Get Reseller Invoices

Description	HTTP Request
Get Reseller Invoices	GET /api/v2/reseller/{resellerId}/Invoice

Copy Business Settings From Template

Description	HTTP Request
Copy Business Settings From Template	POST /api/v2/business/{businessId}/{businessTemplateId}

Create Pay Run (Async)

Description	HTTP Request
Create Pay Run (Async)	POST /api/v2/business/{businessId}/payrun/async

Approve Leave Request

Description	HTTP Request
Approve Leave Request	POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve

Update comments in a timesheet

Description	HTTP Request
Update comments in a timesheet	PUT /api/v2/business/{businessId}/manager/kiosk/timesheetcomments/{timesheetLineId}

Gross To Net Report

Description	HTTP Request
Gross To Net Report	GET /api/v2/business/{businessId}/report/grosstonet

Get Expense Requests

Description	HTTP Request
Create Expense Request	POST /api/v2/ess/{employeeId}/expense
Get Expense Requests	GET /api/v2/ess/{employeeId}/expense

List Pay Rate Templates

Description	HTTP Request
Create Pay Rate Template	POST /api/v2/business/{businessId}/payratetemplate
List Pay Rate Templates	GET /api/v2/business/{businessId}/payratetemplate

List Employee Expense Categories with pagination

Description	HTTP Request
List Employee Expense Categories with pagination	GET /api/v2/business/{businessId}/employeeexpensecategory/paged

Net to Gross

Description	HTTP Request
Net to Gross	POST /api/v2/business/{businessId}/payrun/{payRunId}/nettogross

Verify Kiosk PIN

Description	HTTP Request
Verify Kiosk PIN	POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkpin

Get Employee Tax Adjustment by ID

Description

HTTP Request

Delete Employee Tax Adjustment

DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}

Get Employee Tax Adjustment by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}

Update Employee Tax Adjustment

PUT /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}

Get Employees

Description	HTTP Request
Get Employees	GET /api/v2/ess/security/employees

List Business Notifications

Description	HTTP Request
List Business Notifications	GET /api/v2/business/{businessId}/actionitems/businessnotifications

Discard current shift

Description	HTTP Request
Discard current shift	POST /api/v2/ess/{employeeId}/timeandattendance/discard

List Billing Plans

Description	HTTP Request
List Billing Plans	GET /api/v2/business/{businessId}/subscription/billingplans

List Unavailabilities

Description	HTTP Request
Create Unavailability	POST /api/v2/business/{businessId}/unavailability
List Unavailabilities	GET /api/v2/business/{businessId}/unavailability

List Pay Runs

Description	HTTP Request
Create Pay Run	POST /api/v2/business/{businessId}/payrun
List Pay Runs	GET /api/v2/business/{businessId}/payrun

List Leave Requests

Description	HTTP Request
List Leave Requests	GET /api/v2/business/{businessId}/leaverequest

Stub Shift Timesheets

Description	HTTP Request
Stub Shift Timesheets	POST /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}/stub

Get Reseller Invoice Excel By ID

Description	HTTP Request
Get Reseller Invoice Excel By ID	GET /api/v2/reseller/{resellerId}/Invoice/{id}/excel

Employee Payment History Report

Description	HTTP Request
Employee Payment History Report	GET /api/v2/business/{businessId}/report/paymenthistory

Get Employee Deduction by External Reference Id

Description	HTTP Request
Get Employee Deduction by External Reference Id	GET /api/v2/business/{businessId}/employee/{employeeId}/deduction/{externalReferenceId}

List Pay Run Warnings

Description	HTTP Request
List Pay Run Warnings	GET /api/v2/business/{businessId}/payrun/{payRunId}/warnings

Get Qualification Details

Description	HTTP Request
Get Qualification Details	GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}

List All Business Access Users

Description	HTTP Request
Assign Business Access	POST /api/v2/business/{businessId}/access
List All Business Access Users	GET /api/v2/business/{businessId}/access
Revoke Business Access	DELETE /api/v2/business/{businessId}/access
Update details of an associated user	PUT /api/v2/business/{businessId}/access

List Employee Documents

Description	HTTP Request
Create Employee Document	POST /api/v2/business/{businessId}/employee/{employeeId}/document
List Employee Documents	GET /api/v2/business/{businessId}/employee/{employeeId}/document
Update Employee Document Permissions	PUT /api/v2/business/{businessId}/employee/{employeeId}/document

Employee Payment History Report as Excel

Description	HTTP Request
Employee Payment History Report as Excel	GET /api/v2/business/{businessId}/report/paymenthistory/xlsx

Get Shift Periods for Employee

Description	HTTP Request
Get Shift Periods for Employee	POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods

Get pay run payments

Description	HTTP Request
Get pay run payments	GET /api/v2/business/{businessId}/payrun/{payRunId}/payments

List Unavailabilities

Description	HTTP Request
Create Unavailability	POST /api/v2/ess/{employeeId}/unavailability
List Unavailabilities	GET /api/v2/ess/{employeeId}/unavailability

List Time Zone Types

Description	HTTP Request
List Time Zone Types	GET /api/v2/business/{businessId}/lookupdata/timezones

Get Rounding Rules

Description	HTTP Request
Get Rounding Rules	GET /api/v2/business/{businessId}/manager/roundingrules
Set Rounding Rules	POST /api/v2/business/{businessId}/manager/roundingrules

List Employer Liability Categories

Description	HTTP Request
Create Employer Liability Category	POST /api/v2/business/{businessId}/employerliabilitycategory
List Employer Liability Categories	GET /api/v2/business/{businessId}/employerliabilitycategory

List Pay Slips

Description	HTTP Request
List Pay Slips	GET /api/v2/ess/{employeeId}/document/payslip

Get Leave Request Attachment

Description	HTTP Request
Get Leave Request Attachment	GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/attachment

Propose Shift Swap

Description	HTTP Request
Propose Shift Swap	POST /api/v2/ess/{employeeId}/shift/swap/propose

List Employee Deductions

Description	HTTP Request
Create Employee Deduction	POST /api/v2/business/{businessId}/employee/{employeeId}/deduction
List Employee Deductions	GET /api/v2/business/{businessId}/employee/{employeeId}/deduction

List Employee Statutory Contribution Adjustments

Description	HTTP Request
Create Employee Statutory Contribution Adjustment	POST /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment
List Employee Statutory Contribution Adjustments	GET /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment

Get Employee Dimension Earnings Line Split By Id

Description

HTTP Request

Delete Dimension Earnings Line Split

DELETE /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension/{dimensionId}/value/{dimensionValueId}

Get Employee Dimension Earnings Line Split By Id

GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension/{dimensionId}/value/{dimensionValueId}

Get Statutory Details

Description	HTTP Request
Get Statutory Details	GET /api/v2/ess/{employeeId}/statutorydetails

Get Creation Status

Description	HTTP Request
Get Creation Status	GET /api/v2/business/{businessId}/payrun/creationstatus/{jobId}

Export journals for a pay run using the ExportPayRunJournalCommand

Description	HTTP Request
Export journals for a pay run using the ExportPayRunJournalCommand	POST /api/v2/business/{businessId}/payrun/{payRunId}/exportjournal

Bulk Accept Roster Shift Swaps

Description	HTTP Request
Bulk Accept Roster Shift Swaps	POST /api/v2/ess/{employeeId}/shift/swap/accept

Get Reseller by ID

Description	HTTP Request
Get Reseller by ID	GET /api/v2/reseller/{id}

Get Document Details by ID

Description	HTTP Request
Get Document Details by ID	GET /api/v2/ess/{employeeId}/document/{documentId}

Get Employee By External Reference ID

Description	HTTP Request
Get Employee By External Reference ID	GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalreferenceid}/{source}

Decline Leave Request

Description	HTTP Request
Decline Leave Request	POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline

Get Employee Lookup Data

Description	HTTP Request
Get Employee Lookup Data	GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/lookupdata/{employeeId}

Employee Audit Report

Description	HTTP Request
Employee Audit Report	GET /api/v2/business/{businessId}/report/employeeaudit

List Tax Codes

Description	HTTP Request
List Tax Codes	GET /api/v2/business/{businessId}/manager/expense/taxcodes

List Report Types

Description	HTTP Request
List Report Types	GET /api/v2/lookupdata/reports

Get Employee location earnings line splits

Description	HTTP Request
Create Earnings line split	POST /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit
Get Employee location earnings line splits	GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit

Terminate Employee in Pay Run

Description	HTTP Request
Terminate Employee in Pay Run	POST /api/v2/business/{businessId}/payrun/{payRunId}/terminate

List Leave Categories

Description	HTTP Request
Create Leave Category	POST /api/v2/business/{businessId}/leavecategory
List Leave Categories	GET /api/v2/business/{businessId}/leavecategory

List Next Pay Dates

Description	HTTP Request
List Next Pay Dates	GET /api/v2/business/{businessId}/payschedule/nextpaydates

Dismiss Business Notifications

Description	HTTP Request
Dismiss Business Notifications	DELETE /api/v2/business/{businessId}/actionitems/businessnotifications/{id}/dismiss

Get Employee Lookup Data

Description	HTTP Request
Get Employee Lookup Data	GET /api/v2/business/{businessId}/kiosk/{kioskId}/lookupdata/{employeeId}

Get Tiered Leave Allowance Template by ID

Description

HTTP Request

Delete Tiered Leave Allowance Template

DELETE /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id}

Get Tiered Leave Allowance Template by ID

GET /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id}

Update Tiered Leave Allowance Template

PUT /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id}

Get Roster Shift by ID

Description	HTTP Request
Get Roster Shift by ID	GET /api/v2/ess/{employeeId}/shift/{rosterShiftId}

Bulk Apply Leave Requests

Description	HTTP Request
Bulk Apply Leave Requests	POST /api/v2/business/{businessId}/payrun/{payRunId}/bulkapplyleaverequests

Get PCB2 Forms

Description	HTTP Request
Get PCB2 Forms	GET /api/v2/ess/{employeeId}/document/pcb2forms

Include Employee

Description	HTTP Request
Include Employee	POST /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId}
Remove Employee from Pay Run	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId}

Send PIN Reset Email

Description	HTTP Request
Send PIN Reset Email	POST /api/v2/business/{businessId}/kiosk/{kioskId}/emailreset

Accept Shift Swap

Description	HTTP Request
Accept Shift Swap	POST /api/v2/ess/{employeeId}/shift/{rosterShiftId}/swap/accept

List all Documents

Description	HTTP Request
List all Documents	GET /api/v2/ess/{employeeId}/document

Get Employee Shift Conditions

Description	HTTP Request
Get Employee Shift Conditions	GET /api/v2/business/{businessId}/employee/{employeeId}/shiftcondition

Finalise Pay Run

Description	HTTP Request
Finalise Pay Run	POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise

Get expense request

Description

HTTP Request

Delete Expense Request

DELETE /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}

Edit Expense Request

PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}

Get expense request

GET /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}

Get Journal Account Types

Description	HTTP Request
Get Journal Account Types	GET /api/v2/business/{businessId}/accounts/types

Get Earnings Lines by Employee ID

Description	HTTP Request
Get Earnings Lines by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}

Get Employing Entity Specific Chart of Accounts

Description

HTTP Request

Delete Employing Entity Specific Chart of Accounts

DELETE /api/v2/business/{businessId}/chartofaccounts/employingEntity/{employingEntityId}

Get Employing Entity Specific Chart of Accounts

GET /api/v2/business/{businessId}/chartofaccounts/employingEntity/{employingEntityId}

Update Employing Entity Specific Chart of Accounts

POST /api/v2/business/{businessId}/chartofaccounts/employingEntity/{employingEntityId}

Get Qualification Document File

Description	HTTP Request
Get Qualification Document File	GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}/content

Document Acknowledgements Report

Description	HTTP Request
Document Acknowledgements Report	GET /api/v2/business/{businessId}/report/documentAcknowledgements

List Roster Shifts

Description	HTTP Request
List Roster Shifts	GET /api/v2/ess/{employeeId}/shift

Get Qualification Details

Description	HTTP Request
Delete Employee Qualification	DELETE /api/v2/ess/{employeeId}/qualification/{id}
Get Qualification Details	GET /api/v2/ess/{employeeId}/qualification/{id}
Update Employee Qualification	PUT /api/v2/ess/{employeeId}/qualification/{id}

Get Brand Invoices

Description	HTTP Request
Get Brand Invoices	GET /api/v2/brand/{brandId}/Invoice

Get Employee Statutory Contribution Adjustment by ID

Description

HTTP Request

Delete Employee Statutory Contribution Adjustment

DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id}

Get Employee Statutory Contribution Adjustment by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id}

Update Employee Statutory Contribution Adjustment

PUT /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id}

Leave Balances Report

Description	HTTP Request
Leave Balances Report	GET /api/v2/business/{businessId}/report/leavebalances

Get Dashboard

Description	HTTP Request
Get Dashboard	GET /api/v2/ess/{employeeId}/dashboard

Get Tax Codes

Description	HTTP Request
Get Tax Codes	GET /api/v2/business/{businessId}/employeeexpensecategory/taxcodes

List Employee Group Permission Types

Description	HTTP Request
List Employee Group Permission Types	GET /api/v2/lookupdata/employeegrouppermissions

Get Business Timesheets

Description	HTTP Request
Create timesheet line	POST /api/v2/business/{businessId}/manager/timesheet
Get Business Timesheets	GET /api/v2/business/{businessId}/manager/timesheet

List Pay Run Totals for Employee

Description	HTTP Request
List Pay Run Totals for Employee	GET /api/v2/business/{businessId}/employee/{employeeId}/payruntotals

Grant Kiosk Access

Description	HTTP Request
Grant Kiosk Access	POST /api/v2/business/{businessId}/employee/grantkioskaccess/{employeeId}

Get Rounding Rules

Description	HTTP Request
Get Rounding Rules	GET /api/v2/business/{businessId}/roundingrules
Set Rounding Rules	POST /api/v2/business/{businessId}/roundingrules

Start Approval Process

Description	HTTP Request
Start Approval Process	POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start

List Employee Locations

Description	HTTP Request
List Employee Locations	GET /api/v2/business/{businessId}/employee/{employeeId}/location

Create Note for Employee

Description	HTTP Request
Create Note for Employee	POST /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId}
Delete Note for Employee	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId}

List Pay Runs Summaries

Description	HTTP Request
List Pay Runs Summaries	GET /api/v2/business/{businessId}/payrun/summary

List Employee Groups

Description	HTTP Request
List Employee Groups	GET /api/v2/business/{businessId}/manager/timesheet/employeegroups

Get tasks by business id

Description	HTTP Request
Get tasks by business id	GET /api/v2/business/{businessId}/report/tasks

Activate Employee

Description	HTTP Request
Activate Employee	POST /api/v2/business/{businessId}/employee/activate/{employeeId}

Bulk Accept Roster Shifts

Description	HTTP Request
Bulk Accept Roster Shifts	POST /api/v2/ess/{employeeId}/shift/accept

Get Pay Run Summary

Description	HTTP Request
Get Pay Run Summary	GET /api/v2/business/{businessId}/payrun/{payRunId}/summary

Get Leave Allowances

Description	HTTP Request
Get Leave Allowances	GET /api/v2/business/{businessId}/employee/{employeeId}/leaveallowances
Set Leave Allowances	PUT /api/v2/business/{businessId}/employee/{employeeId}/leaveallowances

Initiate Employee Self Setup

Description	HTTP Request
Initiate Employee Self Setup	POST /api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice

Pay Run Variance Report

Description	HTTP Request
Pay Run Variance Report	GET /api/v2/business/{businessId}/report/payrunvariance/xlsx

Accept Roster Shift

Description	HTTP Request
Accept Roster Shift	POST /api/v2/ess/{employeeId}/shift/{rosterShiftId}/accept

List Employing Entities

Description	HTTP Request
Create Employing Entity	POST /api/v2/business/{businessId}/employingentity
List Employing Entities	GET /api/v2/business/{businessId}/employingentity

Decline Leave Request

Description	HTTP Request
Decline Leave Request	POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/decline

Get Employee Additional Earning by ID

Description

HTTP Request

Delete Employee Additional Earning

DELETE /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id}

Get Employee Additional Earning by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id}

Update Employee Additional Earning

PUT /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id}

Get Leave Allowance Template for Employee

Description	HTTP Request
Get Leave Allowance Template for Employee	GET /api/v2/business/{businessId}/employee/{employeeId}/leaveallowancetemplate

Clock Out Employee

Description	HTTP Request
Clock Out Employee	POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockoff

Recover Forgotten Password

Description	HTTP Request
Recover Forgotten Password	POST /api/v2/ess/security/forgottenpassword

Get Brand Invoice Excel By ID

Description	HTTP Request
Get Brand Invoice Excel By ID	GET /api/v2/brand/{brandId}/Invoice/{id}/excel

Get Public Holidays for Year

Description	HTTP Request
Add a public holiday	POST /api/v2/business/{businessId}/publicholiday
Delete Public Holiday by Date	DELETE /api/v2/business/{businessId}/publicholiday
Get Public Holidays for Year	GET /api/v2/business/{businessId}/publicholiday

Decline Expense Request

Description	HTTP Request
Decline Expense Request	POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/decline

Unregister Device Token

Description	HTTP Request
Unregister Device Token	POST /api/v2/ess/devicetoken/unregister

List Employee Benefits In Kind Adjustments

Description	HTTP Request
Create Employee Benefits In Kind Adjustment	POST /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment
List Employee Benefits In Kind Adjustments	GET /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment

Find Nearby Roster Shifts

Description	HTTP Request
Find Nearby Roster Shifts	GET /api/v2/ess/{employeeId}/shift/nearby

Get Expense Request by ID

Description

HTTP Request

Delete Expense Request

DELETE /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}

Get Expense Request by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}

Update Expense Request

PUT /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}

List Dimensions

Description	HTTP Request
Create Dimension	POST /api/v2/business/{businessId}/dimension
List Dimensions	GET /api/v2/business/{businessId}/dimension

Download Document

Description	HTTP Request
Download Document	GET /api/v2/business/{businessId}/manager/{employeeId}/document/download/{documentId}

Create expense request

Description	HTTP Request
Create expense request	POST /api/v2/business/{businessId}/manager/{employeeId}/expense

Acknowledge Document

Description	HTTP Request
Acknowledge Document	POST /api/v2/ess/{employeeId}/document/acknowledge/{documentId}

Delete Employee

Description	HTTP Request
Delete Employee	DELETE /api/v2/business/{businessId}/employee/{employeeId}

Send PIN Reset SMS

Description	HTTP Request
Send PIN Reset SMS	POST /api/v2/business/{businessId}/kiosk/{kioskId}/smsreset

Get Earnings line split by location ID

Description

HTTP Request

Delete Earnings line split

DELETE /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/{locationId}

Get Earnings line split by location ID

GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/{locationId}

Update Earnings line split

PUT /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/{locationId}

Download EA Form

Description	HTTP Request
Download EA Form	GET /api/v2/ess/{employeeId}/document/eaform/{documentId}

Send PIN Reset Email

Description	HTTP Request
Send PIN Reset Email	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/emailreset

List Pay Categories

Description	HTTP Request
Create Pay Category	POST /api/v2/business/{businessId}/paycategory
List Pay Categories	GET /api/v2/business/{businessId}/paycategory

List Leave Locations

Description	HTTP Request
List Leave Locations	GET /api/v2/business/{businessId}/manager/leaverequest/locations

Get Pay Slip Data by Employee ID

Description	HTTP Request
Get Pay Slip Data by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}

Shifts

Description	HTTP Request
Shifts	POST /api/v2/ess/{employeeId}/timeandattendance/shifts

List Qualifications

Description	HTTP Request
Create Qualification	POST /api/v2/business/{businessId}/qualification
List Qualifications	GET /api/v2/business/{businessId}/qualification

Clock Out Employee

Description	HTTP Request
Clock Out Employee	POST /api/v2/ess/{employeeId}/timeandattendance/clockoff

Deductions Report

Description	HTTP Request
Deductions Report	GET /api/v2/business/{businessId}/report/deductions

Overlapping Leave Requests

Description	HTTP Request
Overlapping Leave Requests	GET /api/v2/business/{businessId}/manager/leaverequest/overlapping

Set Pay Run Notation

Description	HTTP Request
Delete Pay Run Notation	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation
Set Pay Run Notation	POST /api/v2/business/{businessId}/payrun/{payRunId}/notation

Get Location By Id

Description	HTTP Request
Delete Location	DELETE /api/v2/business/{businessId}/location/{id}
Get Location By Id	GET /api/v2/business/{businessId}/location/{id}
Update Location	PUT /api/v2/business/{businessId}/location/{id}

Get Employee Expenses by Employee ID

Description	HTTP Request
Get Employee Expenses by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId}

List Time Zone Types

Description	HTTP Request
List Time Zone Types	GET /api/v2/lookupdata/timezones

Find Nearby Roster Shifts

Description	HTTP Request
Find Nearby Roster Shifts	GET /api/v2/business/{businessId}/rostershift/{employeeId}/nearby

Get Qualifications for Employee

Description	HTTP Request
Add Employee Qualification	POST /api/v2/ess/{employeeId}/qualification
Get Qualifications for Employee	GET /api/v2/ess/{employeeId}/qualification

Get Pay Run

Description	HTTP Request
Delete Pay Run	DELETE /api/v2/business/{businessId}/payrun/{payRunId}
Get Pay Run	GET /api/v2/business/{businessId}/payrun/{payRunId}

Create Unavailability

Description	HTTP Request
Create Unavailability	POST /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability

Get Employee Deduction by ID

Description

HTTP Request

Delete Employee Deduction

DELETE /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}

Get Employee Deduction by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}

Update Employee Deduction

PUT /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}

Get Bank Account by ID

Description

HTTP Request

Delete Bank Account

DELETE /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}

Get Bank Account by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}

Update Bank Account

PUT /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}

List Roster Locations

Description	HTTP Request
List Roster Locations	GET /api/v2/business/{businessId}/manager/rostershift/locations

List Leave Requests

Description	HTTP Request
Create Leave Request	POST /api/v2/ess/{employeeId}/leave
List Leave Requests	GET /api/v2/ess/{employeeId}/leave

Verify Kiosk PIN

Description	HTTP Request
Verify Kiosk PIN	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkpin

Get Employee Profile Image

Description

HTTP Request

Delete Employee Profile Image

DELETE /api/v2/business/{businessId}/manager/employee/{employeeId}/image

Get Employee Profile Image

GET /api/v2/business/{businessId}/manager/employee/{employeeId}/image

Set Employee Profile Image

POST /api/v2/business/{businessId}/manager/employee/{employeeId}/image

Get Business Document Content

Description	HTTP Request
Get Business Document Content	GET /api/v2/business/{businessId}/document/{id}/content

Cancel Shift Swap

Description	HTTP Request
Cancel Shift Swap	POST /api/v2/ess/{employeeId}/shift/{rosterShiftId}/swap/cancel

Costing Report

Description	HTTP Request
Costing Report	GET /api/v2/business/{businessId}/report/costing

Link Employee Document to Expense Request

Description

HTTP Request

Link Employee Document to Expense Request

POST /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/expense/{expenseRequestId}

Unlink Employee Document from Expense Request

DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/expense/{expenseRequestId}

Approve Expense Request

Description	HTTP Request
Approve Expense Request	POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/approve

Get Journal Details

Description	HTTP Request
Get Journal Details	GET /api/v2/business/{businessId}/journal/{payRunId}

Get Business Details by External ID

Description	HTTP Request
Get Business Details by External ID	GET /api/v2/business/externalid

Get Employee Tax Relief Adjustment by ID

Description

HTTP Request

Delete Employee Tax Relief Adjustment

DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id}

Get Employee Tax Relief Adjustment by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id}

Update Employee Tax Relief Adjustment

PUT /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id}

Get Journal Account by ID

Description	HTTP Request
Delete an existing Journal Account	DELETE /api/v2/business/{businessId}/accounts/{id}
Get Journal Account by ID	GET /api/v2/business/{businessId}/accounts/{id}
Update an existing Journal Account	PUT /api/v2/business/{businessId}/accounts/{id}

Bulk Insert Timesheets

Description	HTTP Request
Bulk Insert Timesheets	POST /api/v2/business/{businessId}/timesheet/bulk
Update/Replace timesheets	PUT /api/v2/business/{businessId}/timesheet/bulk

List Timesheet Locations

Description	HTTP Request
List Timesheet Locations	GET /api/v2/business/{businessId}/manager/timesheet/locations

Employee Details Report Fields

Description	HTTP Request
Employee Details Report Fields	GET /api/v2/business/{businessId}/report/employeedetails/fields

Get Business Details

Description	HTTP Request
Get Business Details	GET /api/v2/business/{businessId}

List Leave Employees

Description	HTTP Request
List Leave Employees	GET /api/v2/business/{businessId}/manager/leaverequest/employees

Leave History Report

Description	HTTP Request
Leave History Report	GET /api/v2/business/{businessId}/report/leavehistory

Find Matching Clock Off Roster Shift

Description	HTTP Request
Find Matching Clock Off Roster Shift	GET /api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockoff

Stub Shift Timesheets

Description	HTTP Request
Stub Shift Timesheets	POST /api/v2/business/{businessId}/rostershift/{rosterShiftId}/stub

Get Qualifications for Employee

Description

HTTP Request

Add/Update Employee Qualification

POST /api/v2/business/{businessId}/employee/{employeeId}/qualification

Delete Employee Qualification

DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification

Get Qualifications for Employee

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification

Active Employees Report

Description	HTTP Request
Active Employees Report	GET /api/v2/whitelabel/{whiteLabelId}/reports/activeemployees

Discard current shift

Description	HTTP Request
Discard current shift	POST /api/v2/business/{businessId}/kiosk/{kioskId}/discard

Get Business Billing Plan

Description	HTTP Request
Get Business Billing Plan	GET /api/v2/business/{businessId}/subscription/currentbillingplan

Delete attachment from EmployeeQualification

Description	HTTP Request
Delete attachment from EmployeeQualification	DELETE /api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment/{documentId}

Clock In Employee

Description	HTTP Request
Clock In Employee	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockon

Update Bank Account

Description	HTTP Request
Update Bank Account	PUT /api/v2/ess/{employeeId}/bankaccounts/{id}

List industry options

Description	HTTP Request
List industry options	GET /api/v2/lookupdata/industries

List Employee Expense Categories

Description	HTTP Request
Create Employee Expense Category	POST /api/v2/business/{businessId}/employeeexpensecategory
List Employee Expense Categories	GET /api/v2/business/{businessId}/employeeexpensecategory

Get payment file by ID

Description	HTTP Request
Delete payment file record	DELETE /api/v2/business/{businessId}/paymentfiles/{id}
Get payment file by ID	GET /api/v2/business/{businessId}/paymentfiles/{id}
Update payment file record	PUT /api/v2/business/{businessId}/paymentfiles/{id}

Create Leave Request

Description	HTTP Request
Create Leave Request	POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest

Get Pay Slips by Finalised Pay Run Id

Description	HTTP Request
Get Pay Slips by Finalised Pay Run Id	GET /api/v2/business/{businessId}/report/payslip

Get Dashboard

Description	HTTP Request
Get Dashboard	GET /api/v2/business/{businessId}/manager/dashboard

List Employee Expenses

Description

HTTP Request

Create Employee Expenses

POST /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses

Delete Employee Expense

DELETE /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses

List Employee Expenses

GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses

Update Unavailability

Description

HTTP Request

Delete Unavailability

DELETE /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId}

Update Unavailability

PUT /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId}

Employees Eligible For Shift Swap

Description	HTTP Request
Employees Eligible For Shift Swap	GET /api/v2/ess/{employeeId}/shift/{rosterShiftId}/swap/candidates

Get Employee Work Types

Description	HTTP Request
Get Employee Work Types	GET /api/v2/business/{businessId}/employee/{employeeId}/worktype

List Leave Allowance Templates

Description	HTTP Request
Create Leave Allowance Template	POST /api/v2/business/{businessId}/leaveallowancetemplate
List Leave Allowance Templates	GET /api/v2/business/{businessId}/leaveallowancetemplate

Get Expense Payment Summary

Description	HTTP Request
Get Expense Payment Summary	GET /api/v2/ess/{employeeId}/expense/summary

Search Suburbs

Description	HTTP Request
Search Suburbs	GET /api/v2/ess/{employeeId}/lookup/suburbs

Get Business Invoice By ID

Description	HTTP Request
Get Business Invoice By ID	GET /api/v2/business/{businessId}/Invoice/{id}

Get Locations

Description	HTTP Request
Get Locations	GET /api/v2/ess/{employeeId}/lookup/location

Get Employer Liabilities by Employee ID

Description	HTTP Request
Get Employer Liabilities by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId}

Get Employee Document Content

Description	HTTP Request
Get Employee Document Content	GET /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/content

Find Nearby Roster Shifts

Description	HTTP Request
Find Nearby Roster Shifts	GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/nearby

Get Journal Service provider

Description	HTTP Request
Get Journal Service provider	GET /api/v2/business/{businessId}/accounts/journalservice
Update Journal Service provider	PUT /api/v2/business/{businessId}/accounts/journalservice

List Earnings Lines

Description	HTTP Request
Create Earnings Lines	POST /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Delete Earnings Line	DELETE /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
List Earnings Lines	GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines

List Employee Tax Adjustments

Description	HTTP Request
Create Employee Tax Adjustment	POST /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment
List Employee Tax Adjustments	GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment

Upload Attachment to Expense Request

Description	HTTP Request
Upload Attachment to Expense Request	PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/attachment

Estimate Leave Units

Description	HTTP Request
Estimate Leave Units	GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/estimate

Get Employee Dimension Earnings Line Splits

Description

HTTP Request

Create Dimension Earnings Line Split

POST /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension

Get Employee Dimension Earnings Line Splits

GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension

Update Dimension Earnings Line Split

PUT /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension

Get EA Forms

Description	HTTP Request
Get EA Forms	GET /api/v2/ess/{employeeId}/document/eaforms

List Bank Accounts

Description	HTTP Request
Create Bank Account	POST /api/v2/ess/{employeeId}/bankaccounts
List Bank Accounts	GET /api/v2/ess/{employeeId}/bankaccounts

Get Employee Profile Image

Description	HTTP Request
Delete Employee Profile Image	DELETE /api/v2/ess/{employeeId}/profileimage
Get Employee Profile Image	GET /api/v2/ess/{employeeId}/profileimage
Set Employee Profile Image	POST /api/v2/ess/{employeeId}/profileimage

Approve Expense Request

Description	HTTP Request
Approve Expense Request	POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/approve

Find Matching Clock On Roster Shift

Description	HTTP Request
Find Matching Clock On Roster Shift	GET /api/v2/ess/{employeeId}/shift/matchingclockon

Get Tax Codes

Description	HTTP Request
Get Tax Codes	GET /api/v2/ess/{employeeId}/expense/taxcodes

Get pay rate adjustment schedule record by ID

Description

HTTP Request

Delete pay rate adjustment schedule record

DELETE /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{payRateScheduleId}

Get pay rate adjustment schedule record by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{payRateScheduleId}

Update pay rate adjustment schedule record

PUT /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{payRateScheduleId}

Start Break

Description	HTTP Request
Start Break	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/startbreak

Get Employer liability by ID

Description

HTTP Request

Delete Employer liability

DELETE /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id}

Get Employer liability by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id}

Update Employer liability

PUT /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id}

List Bank Accounts

Description	HTTP Request
Create Bank Account	POST /api/v2/business/{businessId}/employee/{employeeId}/bankaccount
List Bank Accounts	GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount

Shifts

Description	HTTP Request
Shifts	POST /api/v2/business/{businessId}/manager/kiosk/shifts

Get Journal Accounts

Description	HTTP Request
Create a new Journal Account	POST /api/v2/business/{businessId}/accounts
Get Journal Accounts	GET /api/v2/business/{businessId}/accounts

List Kiosk Staff

Description	HTTP Request
Add an Employee	POST /api/v2/business/{businessId}/kiosk/{kioskId}/staff
List Kiosk Staff	GET /api/v2/business/{businessId}/kiosk/{kioskId}/staff

Link Employee Document to Timesheet

Description

HTTP Request

Link Employee Document to Timesheet

POST /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/timesheet/{timesheetLineId}

Unlink Employee Document from Timesheet

DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/timesheet/{timesheetLineId}

Get Web Hook Registration by ID

Description	HTTP Request
Delete Web Hook Registration	DELETE /api/v2/business/{businessId}/webhookregistrations/{id}
Get Web Hook Registration by ID	GET /api/v2/business/{businessId}/webhookregistrations/{id}
Update Web Hook Registration	PUT /api/v2/business/{businessId}/webhookregistrations/{id}

List Kiosk Staff

Description	HTTP Request
Add an Employee	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff
List Kiosk Staff	GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff

Get Pay Condition Rule Set by ID

Description	HTTP Request
Get Pay Condition Rule Set by ID	GET /api/v2/business/{businessId}/payconditionruleset/{id}
Update Pay Condition Rule Set	PUT /api/v2/business/{businessId}/payconditionruleset/{id}

List Expense Request Locations

Description	HTTP Request
List Expense Request Locations	GET /api/v2/business/{businessId}/manager/expense/locations

Mark Shift Notes Read

Description	HTTP Request
Mark Shift Notes Read	POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/read-state

List Businesses

Description	HTTP Request
List Businesses	GET /api/v2/manager/security/businesses

Get unavailability by ID

Description	HTTP Request
Delete Unavailability	DELETE /api/v2/business/{businessId}/unavailability/{id}
Get unavailability by ID	GET /api/v2/business/{businessId}/unavailability/{id}
Update Unavailability	PUT /api/v2/business/{businessId}/unavailability/{id}

Get Leave Request by ID

Description

HTTP Request

Delete Leave Request

DELETE /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}

Get Leave Request by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}

Update Leave Request

PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}

Get Roster Shifts

Description	HTTP Request
Create roster shift	POST /api/v2/business/{businessId}/manager/rostershift
Get Roster Shifts	GET /api/v2/business/{businessId}/manager/rostershift

Get Statutory Settings

Description	HTTP Request
Get Statutory Settings	GET /api/v2/business/{businessId}/statutorysettings
Set Statutory Settings	POST /api/v2/business/{businessId}/statutorysettings

Get the timesheet settings for the business

Description	HTTP Request
Get the timesheet settings for the business	GET /api/v2/business/{businessId}/timesheetsettings
Update the timesheet settings for the business	PUT /api/v2/business/{businessId}/timesheetsettings

Leave Liability Report

Description	HTTP Request
Leave Liability Report	GET /api/v2/business/{businessId}/report/leaveliability

Get Leave Requests for Employee

Description

HTTP Request

Create Leave Request

POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest

Get Leave Requests for Employee

GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest

Update Leave Request

PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest

List Employee Additional Earnings

Description	HTTP Request
Create Employee Additional Earning	POST /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings
List Employee Additional Earnings	GET /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings

List Kiosks

Description	HTTP Request
Create Kiosk	POST /api/v2/business/{businessId}/kiosk
List Kiosks	GET /api/v2/business/{businessId}/kiosk

Get Business Timesheets

Description	HTTP Request
Create timesheet line	POST /api/v2/business/{businessId}/timesheet
Get Business Timesheets	GET /api/v2/business/{businessId}/timesheet

Recalculate background job

Description	HTTP Request
Recalculate background job	POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate/async

Get Work Types

Description	HTTP Request
Get Work Types	GET /api/v2/ess/{employeeId}/lookup/worktype

Bulk Decline Roster Shifts

Description	HTTP Request
Bulk Decline Roster Shifts	POST /api/v2/ess/{employeeId}/shift/decline

Get Journal Service providers

Description	HTTP Request
Get Journal Service providers	GET /api/v2/business/{businessId}/accounts/journalservices

Get Pay Schedule Metadata

Description	HTTP Request
Get Pay Schedule Metadata	GET /api/v2/business/{businessId}/payschedule/metadata

List Roster Employees

Description	HTTP Request
List Roster Employees	GET /api/v2/business/{businessId}/manager/rostershift/employees

Get Leave Request by ID

Description

HTTP Request

Delete Leave Request

DELETE /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}

Get Leave Request by ID

GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}

Update Leave Request

POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}

Get Deduction Category By ID

Description	HTTP Request
Delete Deduction Category	DELETE /api/v2/business/{businessId}/deductioncategory/{id}
Get Deduction Category By ID	GET /api/v2/business/{businessId}/deductioncategory/{id}
Update Deduction Category	PUT /api/v2/business/{businessId}/deductioncategory/{id}

End Break

Description	HTTP Request
End Break	POST /api/v2/business/{businessId}/kiosk/{kioskId}/endbreak

Get Leave Request by ID

Description	HTTP Request
Delete Leave Request	DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId}
Get Leave Request by ID	GET /api/v2/ess/{employeeId}/leave/{leaveRequestId}
Update Leave Request	POST /api/v2/ess/{employeeId}/leave/{leaveRequestId}

Link Employee Document to Leave Request

Description

HTTP Request

Link Employee Document to Leave Request

POST /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/leave/{leaveRequestId}

Unlink Employee Document from Leave Request

DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}/leave/{leaveRequestId}

Get Work Type by ID

Description	HTTP Request
Delete Work Type	DELETE /api/v2/business/{businessId}/worktype/{id}
Get Work Type by ID	GET /api/v2/business/{businessId}/worktype/{id}
Update Work Type	PUT /api/v2/business/{businessId}/worktype/{id}

Get timesheet reference data

Description	HTTP Request
Get timesheet reference data	GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/reference

Journal Report

Description	HTTP Request
Journal Report	GET /api/v2/business/{businessId}/report/journal

Timesheet Report

Description	HTTP Request
Timesheet Report	GET /api/v2/business/{businessId}/report/timesheet

Get Leave Allowances for All Employees

Description	HTTP Request
Get Leave Allowances for All Employees	GET /api/v2/business/{businessId}/leaveallowances
Set Leave Allowances	PUT /api/v2/business/{businessId}/leaveallowances

List gender options

Description	HTTP Request
List gender options	GET /api/v2/lookupdata/genders

List Leave Requests

Description	HTTP Request
List Leave Requests	GET /api/v2/business/{businessId}/manager/leaverequest

Test Web Hook

Description	HTTP Request
Test Web Hook	GET /api/v2/business/{businessId}/webhookregistrations/{id}/test

List Expense Categories

Description	HTTP Request
List Expense Categories	GET /api/v2/business/{businessId}/manager/expense/categories

Get Employee Benefits In Kind Adjustment by ID

Description

HTTP Request

Delete Employee Benefits In Kind Adjustment

DELETE /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id}

Get Employee Benefits In Kind Adjustment by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id}

Update Employee Benefits In Kind Adjustment

PUT /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id}

Get Shift Notes

Description	HTTP Request
Add Note to Shift	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes
Get Shift Notes	GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes

List Business Locations

Description	HTTP Request
Create Location	POST /api/v2/business/{businessId}/location
List Business Locations	GET /api/v2/business/{businessId}/location

List Leave Categories

Description	HTTP Request
List Leave Categories	GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/categories

Get timesheet

Description

HTTP Request

Delete Timesheet

DELETE /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}

Edit Timesheet

POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}

Get timesheet

GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}

Get Pay Rates

Description	HTTP Request
Get Pay Rates	GET /api/v2/business/{businessId}/employee/{employeeId}/payrate

Get the list of roles available

Description	HTTP Request
Get the list of roles available	GET /api/v2/business/{businessId}/manager/rostershift/roles

List Documents for Employee Qualification

Description	HTTP Request
Create Employee Qualification Document	POST /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document
List Documents for Employee Qualification	GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document

Set UI Unlock enabled

Description	HTTP Request
Set UI Unlock enabled	POST /api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate

Get Expense Categories

Description	HTTP Request
Get Expense Categories	GET /api/v2/ess/{employeeId}/expense/categories

Delete Note from Shift

Description	HTTP Request
Delete Note from Shift	DELETE /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId}

List basic details for employees

Description	HTTP Request
List basic details for employees	GET /api/v2/business/{businessId}/employee/details

Get Business Timesheets

Description	HTTP Request
Create kiosk timesheet line	POST /api/v2/business/{businessId}/manager/kiosk/timesheet
Get Business Timesheets	GET /api/v2/business/{businessId}/manager/kiosk/timesheet

List Pay Run Totals

Description	HTTP Request
List Pay Run Totals	GET /api/v2/business/{businessId}/payrun/{payRunId}/totals

Get Employee Profile Image

Description	HTTP Request
Delete Employee Profile Image	DELETE /api/v2/business/{businessId}/employee/{employeeId}/image
Get Employee Profile Image	GET /api/v2/business/{businessId}/employee/{employeeId}/image
Set Employee Profile Image	POST /api/v2/business/{businessId}/employee/{employeeId}/image

List Pay Slip Data

Description	HTTP Request
List Pay Slip Data	GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips

Get Employee Access for User

Description	HTTP Request
Get Employee Access for User	GET /api/v2/business/{businessId}/employee/{employeeId}/access/email

Get Leave Balances

Description	HTTP Request
Get Leave Balances	GET /api/v2/business/{businessId}/employee/{employeeId}/leavebalances

Get Payment Files by Finalised Pay Run Id

Description	HTTP Request
Get Payment Files by Finalised Pay Run Id	GET /api/v2/business/{businessId}/report/paymentfile

Single Sign On

Description	HTTP Request
Single Sign On	POST /api/v2/business/{businessId}/singlesignon

Leave Liability report as Excel

Description	HTTP Request
Leave Liability report as Excel	GET /api/v2/business/{businessId}/report/leaveliability/xlsx

Get User Details

Description	HTTP Request
Create New User	POST /api/v2/user
Get User Details	GET /api/v2/user
Update User	PUT /api/v2/user

List Dimension Values

Description	HTTP Request
Create Dimension Value	POST /api/v2/business/{businessId}/dimension/{dimensionId}/value
List Dimension Values	GET /api/v2/business/{businessId}/dimension/{dimensionId}/value

Leave Balances Report as Excel

Description	HTTP Request
Leave Balances Report as Excel	GET /api/v2/business/{businessId}/report/leavebalances/xlsx

Get Pay Schedule by ID

Description	HTTP Request
Delete Pay Schedule	DELETE /api/v2/business/{businessId}/payschedule/{id}
Get Pay Schedule by ID	GET /api/v2/business/{businessId}/payschedule/{id}
Update Pay Schedule	PUT /api/v2/business/{businessId}/payschedule/{id}

Clock In Employee

Description	HTTP Request
Clock In Employee	POST /api/v2/ess/{employeeId}/timeandattendance/clockon

Get shift swapping report by business id

Description	HTTP Request
Get shift swapping report by business id	GET /api/v2/business/{businessId}/report/shiftswapping

Get Enabled Features

Description	HTTP Request
Get Enabled Features	GET /api/v2/ess/{employeeId}/security/features

Get public holidays

Description	HTTP Request
Get public holidays	GET /api/v2/ess/{employeeId}/publicHolidays

End Break

Description	HTTP Request
End Break	POST /api/v2/ess/{employeeId}/timeandattendance/endbreak

Change PIN

Description	HTTP Request
Change PIN	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/changepin

Get Leave Balances

Description	HTTP Request
Get Leave Balances	GET /api/v2/ess/{employeeId}/leave/balances

Change PIN

Description	HTTP Request
Change PIN	POST /api/v2/business/{businessId}/kiosk/{kioskId}/changepin

Download Document

Description	HTTP Request
Download Document	GET /api/v2/ess/{employeeId}/document/download/{documentId}

List Pay Schedules

Description	HTTP Request
Create Pay Schedule	POST /api/v2/business/{businessId}/payschedule
List Pay Schedules	GET /api/v2/business/{businessId}/payschedule

List Web Hook Registrations

Description	HTTP Request
Delete all Web Hook Registrations	DELETE /api/v2/business/{businessId}/webhookregistrations
List Web Hook Registrations	GET /api/v2/business/{businessId}/webhookregistrations
Register Web Hook	POST /api/v2/business/{businessId}/webhookregistrations

Get Users With Access to Employee

Description	HTTP Request
Get Users With Access to Employee	GET /api/v2/business/{businessId}/employee/{employeeId}/access
Grant Employee Access	POST /api/v2/business/{businessId}/employee/{employeeId}/access
Revoke Employee Access	DELETE /api/v2/business/{businessId}/employee/{employeeId}/access
Update Employee Access Record	PUT /api/v2/business/{businessId}/employee/{employeeId}/access

Get White Label by ID

Description	HTTP Request
Get White Label by ID	GET /api/v2/whitelabel/{id}

Find Matching Clock Off Roster Shift

Description	HTTP Request
Find Matching Clock Off Roster Shift	GET /api/v2/ess/{employeeId}/shift/matchingclockoff

Estimate Leave Hours

Description	HTTP Request
Estimate Leave Hours	GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/estimate

Initiate Employee Self Setup

Description	HTTP Request
Initiate Employee Self Setup	POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice

Get Employing Entity By ID

Description	HTTP Request
Delete Employing Entity	DELETE /api/v2/business/{businessId}/employingentity/{id}
Get Employing Entity By ID	GET /api/v2/business/{businessId}/employingentity/{id}
Update Employing Entity	PUT /api/v2/business/{businessId}/employingentity/{id}

Get Leave Categories

Description	HTTP Request
Get Leave Categories	GET /api/v2/ess/{employeeId}/leave/leavecategories

List pay rate adjustment schedule

Description	HTTP Request
Create pay rate adjustment schedule record	POST /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule
List pay rate adjustment schedule	GET /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule

Get Pay Slip File

Description	HTTP Request
Get Pay Slip File	GET /api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId}

Get Details

Description	HTTP Request
Get Details	GET /api/v2/ess/{employeeId}/details
Save Details	POST /api/v2/ess/{employeeId}/details

Get Kiosk by ID

Description	HTTP Request
Get Kiosk by ID	GET /api/v2/business/{businessId}/manager/kiosk/{id}

Upload Attachment to Expense Request

Description	HTTP Request
Upload Attachment to Expense Request	PUT /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/attachment

Birthday Report

Description	HTTP Request
Birthday Report	GET /api/v2/business/{businessId}/report/birthday

Get Business Expense Requests

Description	HTTP Request
Get Business Expense Requests	GET /api/v2/business/{businessId}/manager/expense

List Employees

Description	HTTP Request
Create or Update Employee	POST /api/v2/business/{businessId}/employee/unstructured
List Employees	GET /api/v2/business/{businessId}/employee/unstructured

List Employee Deductions By External Reference Id

Description	HTTP Request
List Employee Deductions By External Reference Id	POST /api/v2/business/{businessId}/employee/deduction

Get List of Employees

Description	HTTP Request
Get List of Employees	GET /api/v2/business/{businessId}/manager/employees

Signup Report

Description	HTTP Request
Signup Report	GET /api/v2/whitelabel/{whitelabelId}/reports/signups

Overlapping Leave Requests

Description	HTTP Request
Overlapping Leave Requests	GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/overlapping

Get payslip configuration

Description	HTTP Request
Create payslip configuration	POST /api/v2/business/{businessId}/payslip
Get payslip configuration	GET /api/v2/business/{businessId}/payslip

Get Qualification Document by ID

Description

HTTP Request

Delete Employee Qualification Document

DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}

Get Qualification Document by ID

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}

Get Emergency Contacts

Description	HTTP Request
Get Emergency Contacts	GET /api/v2/ess/{employeeId}/emergencycontacts
Save Emergency Contacts	POST /api/v2/ess/{employeeId}/emergencycontacts
Update Emergency Contacts	PUT /api/v2/ess/{employeeId}/emergencycontacts

Get Dimension Value by ID

Description

HTTP Request

Delete Dimension Value

DELETE /api/v2/business/{businessId}/dimension/{dimensionId}/value/{id}

Get Dimension Value by ID

GET /api/v2/business/{businessId}/dimension/{dimensionId}/value/{id}

Update Dimension Value

PUT /api/v2/business/{businessId}/dimension/{dimensionId}/value/{id}

Delete Note from Shift

Description	HTTP Request
Delete Note from Shift	DELETE /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId}

Get Roster Shifts

Description	HTTP Request
Create roster shift	POST /api/v2/business/{businessId}/rostershift
Get Roster Shifts	GET /api/v2/business/{businessId}/rostershift

Send PIN Reset SMS

Description	HTTP Request
Send PIN Reset SMS	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/smsreset

Recalculate

Description	HTTP Request
Recalculate	POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate

Discard current shift

Description	HTTP Request
Discard current shift	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/discard

Roster vs Timesheet Comparison Report

Description	HTTP Request
Roster vs Timesheet Comparison Report	GET /api/v2/business/{businessId}/report/rostertimesheetcomparison

Get Brand Invoice PDF By ID

Description	HTTP Request
Get Brand Invoice PDF By ID	GET /api/v2/brand/{brandId}/Invoice/{id}/pdf

Get Personal Details

Description	HTTP Request
Get Personal Details	GET /api/v2/ess/{employeeId}/personaldetails
Update Personal Details	PUT /api/v2/ess/{employeeId}/personaldetails

Get Dimension by ID

Description	HTTP Request
Delete Dimension	DELETE /api/v2/business/{businessId}/dimension/{id}
Get Dimension by ID	GET /api/v2/business/{businessId}/dimension/{id}
Update Dimension	PUT /api/v2/business/{businessId}/dimension/{id}

Get Business Invoice PDF By ID

Description	HTTP Request
Get Business Invoice PDF By ID	GET /api/v2/business/{businessId}/Invoice/{id}/pdf

List Pay Condition Rule Sets

Description	HTTP Request
Create Pay Condition Rule Set	POST /api/v2/business/{businessId}/payconditionruleset
List Pay Condition Rule Sets	GET /api/v2/business/{businessId}/payconditionruleset

Update timesheet line

Description	HTTP Request
Update timesheet line	PUT /api/v2/business/{businessId}/manager/timesheet/{timesheetLineId}

Decline Expense Request

Description	HTTP Request
Decline Expense Request	POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/decline

Get Pay Rate Template by ID

Description	HTTP Request
Delete Pay Rate Template	DELETE /api/v2/business/{businessId}/payratetemplate/{id}
Get Pay Rate Template by ID	GET /api/v2/business/{businessId}/payratetemplate/{id}
Update Pay Rate Template	PUT /api/v2/business/{businessId}/payratetemplate/{id}

Get Bank Account by ID

Description	HTTP Request
Delete Bank Account	DELETE /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}
Get Bank Account by ID	GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}
Update Bank Account	PUT /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}

Get Satisfaction Survey Results

Description	HTTP Request
Get Satisfaction Survey Results	GET /api/v2/ess/{employeeId}/satisfaction
Submit Satisfaction Survey	POST /api/v2/ess/{employeeId}/satisfaction

Get Employee Group by ID

Description	HTTP Request
Delete Employee Group	DELETE /api/v2/business/{businessId}/employeegroup/{id}
Get Employee Group by ID	GET /api/v2/business/{businessId}/employeegroup/{id}
Update Employee Group	PUT /api/v2/business/{businessId}/employeegroup/{id}

Mark Shift Notes Read

Description	HTTP Request
Mark Shift Notes Read	POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes/read-state

Download PCB2 Form

Description	HTTP Request
Download PCB2 Form	GET /api/v2/ess/{employeeId}/document/pcb2form/{documentId}

Get Employee Document Details

Description	HTTP Request
Delete Employee Document	DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}
Get Employee Document Details	GET /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}

List Expense Request Employees

Description	HTTP Request
List Expense Request Employees	GET /api/v2/business/{businessId}/manager/expense/employees

Get Employee Notes

Description	HTTP Request
Get Employee Notes	GET /api/v2/business/{businessId}/employee/{employeeId}/notes
Set Employee Notes	POST /api/v2/business/{businessId}/employee/{employeeId}/notes

Get Lookup Data

Description	HTTP Request
Get Lookup Data	GET /api/v2/ess/{employeeId}/timeandattendance/lookupdata

List Brand Labels

Description	HTTP Request
List Brand Labels	GET /api/v2/brand

Get Deductions by Employee ID

Description	HTTP Request
Get Deductions by Employee ID	GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId}

List Manager Roster Employees

Description	HTTP Request
List Manager Roster Employees	GET /api/v2/business/{businessId}/manager/rostershift/manageemployees

List the Business tags

Description	HTTP Request
List the Business tags	GET /api/v2/business/{businessId}/tags

End Break

Description	HTTP Request
End Break	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/endbreak

Get Public Holiday Details

Description	HTTP Request
Delete Public Holiday	DELETE /api/v2/business/{businessId}/publicholiday/{id}
Get Public Holiday Details	GET /api/v2/business/{businessId}/publicholiday/{id}
Update Public Holiday	PUT /api/v2/business/{businessId}/publicholiday/{id}

Pay Run Inclusions Report

Description	HTTP Request
Pay Run Inclusions Report	GET /api/v2/business/{businessId}/report/payruninclusions

Get Timesheet Creation Data

Description	HTTP Request
Get Timesheet Creation Data	GET /api/v2/ess/{employeeId}/timesheet/data

Manage Roster Data

Description	HTTP Request
Manage Roster Data	GET /api/v2/business/{businessId}/manager/rostershift/manage

List Timesheets

Description	HTTP Request
List Timesheets	GET /api/v2/ess/{employeeId}/timesheet
Submit or Update Timesheet	POST /api/v2/ess/{employeeId}/timesheet

Bulk Decline Roster Shift Swaps

Description	HTTP Request
Bulk Decline Roster Shift Swaps	POST /api/v2/ess/{employeeId}/shift/swap/decline

Get Employee By ID

Description	HTTP Request
Get Employee By ID	GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}
Update Employee	PUT /api/v2/business/{businessId}/employee/unstructured/{employeeId}

Approve Leave Request

Description	HTTP Request
Approve Leave Request	POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/approve

Mark Shift Notes Read

Description	HTTP Request
Mark Shift Notes Read	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/read-state

Check Employee

Description	HTTP Request
Check Employee	POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkid

List banks

Description	HTTP Request
List banks	GET /api/v2/bank

Check Employee

Description	HTTP Request
Check Employee	POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkid

Get Suburb

Description	HTTP Request
Get Suburb	GET /api/v2/ess/{employeeId}/lookup/suburb

Signup Report

Description	HTTP Request
Signup Report	GET /api/v2/brand/{brandId}/reports/signups

Employee Details Report

Description	HTTP Request
Employee Details Report	GET /api/v2/business/{businessId}/report/employeedetails
Employee Details Report	POST /api/v2/business/{businessId}/report/employeedetails

Edit Timesheet

Description	HTTP Request
Delete Timesheet	DELETE /api/v2/ess/{employeeId}/timesheet/{timesheetId}
Edit Timesheet	POST /api/v2/ess/{employeeId}/timesheet/{timesheetId}

Find Matching Clock On Roster Shift

Description	HTTP Request
Find Matching Clock On Roster Shift	GET /api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockon

Malaysia reference

Detailed Activity Report as Excel

Create a new direct billing user

Update roster shift

Pay Run Audit Report

List Tiered Leave Allowance Templates

List Leave Categories

List White Labels

List Employer Liabilities

List Addresses

List Business Templates

Get Expense Request by ID

Single Sign On

List Deduction Categories

Get standard hours for employee

Active Employees Report

Get Brand Invoice By ID

Upload Attachment to Leave Request

Get Location Specific Chart of Accounts

Get Business Invoices

List Businesses

List Resellers

Get Leave Category by ID

Unlock Pay Run

Find Matching Clock Off Roster Shift

Start Break

Get Brand Label by ID

Get User Business Access

Start Payment Approval Process

Bulk insert Journal Accounts

Upload attachment to qualification

Get Shift Notes

List Employee Locations

Get expenses reference data

Clock Out Employee

List payment files

Get Pay Slip by Pay Run ID

Get Employee Expense Category by ID

Get Shift Conditions

Get Pay Run Totals by Employee ID

List Employee Locations

List countries

Get Reseller Invoice By ID

Get Leave Balances

Clock In Employee

Upload Attachment to Expense Request

Get Roster Shift by ID

Get Titles

Estimate Leave Hours

Get Shift Costings for Employee

Decline Roster Shift

Decline Shift Swap

List Work Types

Get Leave Accruals

List Timesheet Employees

Gross To Net Report as Excel

Get Business Document Details

Clone Pay Condition Rule Set

List Expense Requests

Get the initial tax year

Get Employee Expense by ID

List Employer liabilities

Assign Leave Allowance Template

Bulk Cancel Roster Shift Swaps

Find Matching Clock On Roster Shift

Get Leave Accruals for Employee

Add Complete Shift for Employee

Get Leave Allowances for Employee

List Business Document Details

Set Business Billing Plan

List Employee Expenses

Cancel Business

OAuth Token

Get Qualification by ID

Register Device Token

Start Break

Get Employee basic details by ID

List Entitlements

Pay Categories Report

Get Chart of Accounts