New Zealand reference

List Addresses

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

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}

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

Get Reseller Invoice Excel By ID

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

List Leave Requests

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

Costing Report

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

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

Single Sign On

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

Revoke Kiosk Access

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

Get KiwiSaver Enrollment Options

Description HTTP Request
Get KiwiSaver Enrollment Options 
GET /api/v2/ess/{employeeId}/lookup/enrollmentoptions

Manage Roster Data

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

Get Brand Invoices

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

Get tasks by business id

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

Set UI Unlock enabled

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

List Employee Groups

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

Find Matching Clock Off Roster Shift

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

Get Leave Request Attachment

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

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

Get Expense Payment Summary

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

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}

Upload attachment to qualification

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

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}

Overlapping Leave Requests

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

Roster vs Timesheet Comparison Report

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

Verify Kiosk PIN

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

Clock In Employee

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

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

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 Expense Request Locations

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

Get Expense Categories

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

Get pay run payments

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

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 Expense Request Employees

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

Get Lookup Data

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

Get Employee Access for User

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

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

Get Earnings Certificate PDF

Description HTTP Request
Get Earnings Certificate PDF 
GET /api/v2/ess/{employeeId}/document/earningscertificate/{documentId}

Get Journal Service providers

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

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

Start Payment Approval Process

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

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 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 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}

Send PIN Reset SMS

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

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}

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}

Get White Label by ID

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

Update kiosk timesheet line

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

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

List Pay Run Totals for Employee

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

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}

Clone Pay Condition Rule Set

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

Send PIN Reset Email

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

Employees Eligible For Shift Swap

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

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}

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

List Employee Group Permission Types

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

List Unavailabilities

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

Get Employee Lookup Data

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

List Leave Requests

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

List Next Pay Dates

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

List Timesheets

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

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

Decline Leave Request

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

Unregister Device Token

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

Start Approval Process

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

Decline Expense Request

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

Reapply Leave Allowance Template

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

Active Employees Report

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

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}

Timesheet Report

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

Search Suburbs

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

Get Pay Run Summary

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

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}

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

Mark Shift Notes Read

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

Find Nearby Roster Shifts

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

Get KiwiSaver Adjustments by Employee ID

Description HTTP Request
Get KiwiSaver Adjustments by Employee ID 
GET /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments/{employeeId}

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}

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

Gross To Net Report as Excel

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

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

Grant Kiosk Access

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

Add Complete Shift for Employee

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

List Tax Codes

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

Send PIN Reset SMS

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

Get Deductions by Employee ID

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

Get Reseller Invoices

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

List Pay Run Warnings

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

Find Matching Clock Off Roster Shift

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

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

Get Business Document Content

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

Change PIN

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

Get PAYE Adjustments by Employee ID

Description HTTP Request
Get PAYE Adjustments by Employee ID 
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId}

Get Work Types

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

Create Unavailability

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

Get List of Employees

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

Get Business Timesheets

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

Get KiwiSaver options for employee

Description HTTP Request
Get KiwiSaver options for employee 
GET /api/v2/ess/{employeeId}/kiwisaver

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 Employees

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

Get Business Expense Requests

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

Mark Shift Notes Read

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

Acknowledge Document

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

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

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 Business Locations

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

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

Single Sign On

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

List KiwiSaver Adjustments

Description HTTP Request
Create KiwiSaver Adjustments 
POST /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments
Delete KiwiSaver Adjustment 
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments
List KiwiSaver Adjustments 
GET /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments

Get Bank Payment File

Description HTTP Request
Get Bank Payment File 
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bankpayment/{paymentFileId}

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}

Initiate Employee Self Setup

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

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 Roster Shift by ID

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

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 Holiday Leave Settings

Description HTTP Request
Get Holiday Leave Settings 
GET /api/v2/business/{businessId}/holidayleavesettings
Set Holiday Leave Settings 
PUT /api/v2/business/{businessId}/holidayleavesettings

Activate Employee

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

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}/manager/kiosk/{kioskId}/clockon

List Time Zone Types

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

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 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

Download Document

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

List Businesses

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

List Employee Deductions By External Reference Id

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

List countries

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

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

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

Pay Run Inclusions Report

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

Employee Has Access

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

List Unavailabilities

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

Get Business Invoices

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

Get Employee Lookup Data

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

Deductions Report

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

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 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}

List Kiosks

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

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 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

Cancel Shift Swap

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

Pay Categories Report

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

Find Matching Clock Off Roster Shift

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

Mark Shift Notes Read

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

Ordinary Time Earnings Report

Description HTTP Request
Ordinary Time Earnings Report 
GET /api/v2/business/{businessId}/report/ordinarytimeearnings

Estimate Leave Hours

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

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}

Create a new direct billing user

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

Get Pay Schedule Metadata

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

Get Brand Label by ID

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

Get Locations

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

Bulk Decline Roster Shift Swaps

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

Get Timesheet Creation Data

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

Check Employee

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

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}

Get Leave Balances

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

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}

Update comments in a timesheet

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

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}

Employee Details Report Fields

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

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}

Send PIN Reset Email

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

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 User Business Access

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

Assign Leave Allowance Template

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

List Pay Slip Data

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

List PAYE Adjustments

Description HTTP Request
Create PAYE Adjustments 
POST /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Delete PAYE Adjustment 
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
List PAYE Adjustments 
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments

Get Pay Run Details

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

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 Roster Shifts

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

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 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

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

Leave Liability Report

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

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

Shifts

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

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

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 for Employee

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

Start Break

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

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

Get Kiosk by ID

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

List Employing Entities

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

Get Employee Shift Conditions

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

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}

Bulk Apply Leave Requests

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

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

Get timesheet reference data

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

Change PIN

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

Journal Report

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

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

Get Business Billing Plan

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

List Pay Run Totals

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

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}/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 Reseller Invoice By ID

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

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}

Get Journal Account Types

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

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}

Accept Roster Shift

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

List Bank Accounts

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

Leave Balances Report as Excel

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

Get Titles

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

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 Accept Roster Shifts

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

PAYE Report

Description HTTP Request
PAYE Report 
GET /api/v2/business/{businessId}/report/paye

Detailed Activity Report as Excel

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

Get Brand Invoice Excel By ID

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

Leave Balances Report

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

List Business Notifications

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

Employee Payment History Report

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

List Employee Locations

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

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 Kiosks

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

Get business advanced settings

Description HTTP Request
Get business advanced settings 
GET /api/v2/business/{businessId}/advanced
Update business advanced settings 
PUT /api/v2/business/{businessId}/advanced

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}

Check Employee

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

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}

Create Pay Run (Async)

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

Get Employee By External ID

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

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}

List Employee Groups

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

Get Pay Slip File

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

Decline Roster Shift

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

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}

Cancel Business

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

Get Dashboard

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

Recalculate

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

List Brand Labels

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

List Businesses

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

Get Earnings Certificates

Description HTTP Request
Get Earnings Certificates 
GET /api/v2/ess/{employeeId}/document/earningscertificates

Find Matching Clock On Roster Shift

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

Edit Timesheet

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

Delete attachment from EmployeeQualification

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

Get Leave Allowances for Employee

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

Get Suburb

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

List Time Zone Types

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

Detailed Activity Report

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

Update roster shift

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

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

Shifts

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

Get Document Details by ID

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

Clock Out Employee

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

Find Nearby Roster Shifts

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

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}

Create Leave Request

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

List Leave Employees

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

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

Get List of Locations

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

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

Start Break

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

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}

Verify Kiosk PIN

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

Bulk Decline Roster Shifts

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

Get Dashboard

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

List Leave Locations

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

Initiate Employee Self Setup

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

End Break

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

Get Expense Requests

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

Get Pay Rates

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

Approve Expense Request

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

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}

List Roster Locations

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

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}

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

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

Prepare Leave Liability report

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

Discard current shift

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

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}

Get Business Details by External ID

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

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 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 Billing Plans

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

Dismiss Business Notifications

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

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

Get Shift Costings for Employee

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

Bulk Accept Roster Shift Swaps

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

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

List Pay Slips

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

Terminate Employee in Pay Run

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

OAuth Token

Description HTTP Request
OAuth Token 
POST /oauth/token

List Business Templates

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

List Timesheet Employees

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

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}

Get Employee Expenses by Employee ID

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

Get shift swapping report by business id

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

List Pay Runs Summaries

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

Gross To Net Report

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

List gender options

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

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

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 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 Shift Periods for Employee

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

Get Employee basic details by ID

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

Finalise Pay Run

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

Stub Shift Timesheets

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

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}

Clock Out Employee

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

Single Sign On

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

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}

List basic details for employees

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

Get Leave Allowance Template for Employee

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

Estimate Leave Units

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

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 Roster Employees

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

Get Qualification Details

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

Birthday Report

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

Clock In Employee

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

List Entitlements

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

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

Get the list of roles available

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

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 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 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}

Discard current shift

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

Get Leave Balances

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

List Expense Categories

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

Get Creation Status

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

Delete Employee

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

Delete Note from Shift

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

Upload Attachment to Expense Request

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

List Leave Categories

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

Reject Timesheet

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

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}

List Deduction Categories

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

Net to Gross

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

List Qualifications

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

Pay Run Variance Report

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

Get Details

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

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

End Break

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

Pay Run Audit Report

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

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

Approve Expense Request

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

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 all Documents

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

List the Business tags

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

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}

List Pay Schedules

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

Active Employees Report

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

Recalculate background job

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

Update Bank Account

Description HTTP Request
Update Bank Account 
PUT /api/v2/ess/{employeeId}/bankaccounts/{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 Resellers

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

Upload Attachment to Expense Request

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

Upload Attachment to Expense Request

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

Bulk insert Journal Accounts

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

List Leave Categories

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

Get Reseller Invoice PDF By ID

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

Find Nearby Roster Shifts

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

Set Business Billing Plan

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

Start Break

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

KiwiSaver Report as Excel

Description HTTP Request
KiwiSaver Report as Excel 
GET /api/v2/business/{businessId}/report/kiwisaver/xlsx

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}

Approve Timesheet

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

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

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}

Clock Out Employee

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

Get Employee Document Content

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

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}

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}

List Leave Categories

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

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

Get Employee Work Types

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

Get Tax Codes

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

Get expenses reference data

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

Update timesheet line

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

Test Web Hook

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

List Roster Shifts

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

List Employee Locations

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

List Dimensions

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

Get Employer Liabilities by Employee ID

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

List White Labels

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

Unlock Pay Run

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

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 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

Get Personal Details

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

Stub Shift Timesheets

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

List Leave Requests

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

List Report Types

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

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 Employee Expense Categories with pagination

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

End Break

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

Get Journal Details

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

Get Rounding Rules

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

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}

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}

Register Device Token

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

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 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

Overlapping Leave Requests

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

Get Shift Conditions

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

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

List industry options

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

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}

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

Shifts

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

Recover Forgotten Password

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

Delete Note from Shift

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

Get Brand Invoice By ID

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

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

Estimate Leave Hours

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

Get Enabled Features

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

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}

Get Brand Invoice PDF By ID

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

Employee Audit Report

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

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}

Decline Shift Swap

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

Decline Leave Request

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

KiwiSaver Report

Description HTTP Request
KiwiSaver Report 
GET /api/v2/business/{businessId}/report/kiwisaver

Get public holidays

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

Approve Leave Request

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

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 Timesheet Locations

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

Accept Shift Swap

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

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}

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 Business Details

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

List Employee Locations

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

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

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

List Pay Runs

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

Employee Payment History Report as Excel

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

Bulk Cancel Roster Shift Swaps

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

Create expense request

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

Copy Business Settings From Template

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

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

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}

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

Signup Report

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

Get Tax Codes

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

List Pay Categories

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

Decline Expense Request

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

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}

Get Business Invoice By ID

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

Leave Liability report as Excel

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

Signup Report

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

Get Leave Categories

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

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}

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}

Get Next Pay Date

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

Find Matching Clock On Roster Shift

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

List Manager Roster Employees

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

Get Reseller by ID

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

Discard current shift

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

Download Document

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

Propose Shift Swap

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

Approve Leave Request

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