Description HTTP Request
List Super Funds
GET /api/v2/ess/{employeeId}/superfunds
Create Super Fund
POST /api/v2/ess/{employeeId}/superfunds
Get Expense Requests
GET /api/v2/ess/{employeeId}/expense
Create Expense Request
POST /api/v2/ess/{employeeId}/expense
Get Tax Codes
GET /api/v2/ess/{employeeId}/expense/taxcodes
Clock Out Employee
POST /api/v2/ess/{employeeId}/timeandattendance/clockoff
Get Document Details by ID
GET /api/v2/ess/{employeeId}/document/{documentId}
Cancel Shift Swap
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/cancel
Get Shift Conditions
GET /api/v2/ess/{employeeId}/lookup/shiftcondition
List Bank Accounts
GET /api/v2/ess/{employeeId}/bankaccounts
Create Bank Account
POST /api/v2/ess/{employeeId}/bankaccounts
Decline Roster Shift
POST /api/v2/ess/{employeeId}/shift/{shiftId}/decline
Get Shift Notes
GET /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes
Add Note to Shift
POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes
Decline Shift Swap
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/decline
Get Work Types
GET /api/v2/ess/{employeeId}/lookup/worktype
Get Leave Request by ID
GET /api/v2/ess/{employeeId}/leave/{leaveRequestId}
Update Leave Request
POST /api/v2/ess/{employeeId}/leave/{leaveRequestId}
Delete Leave Request
DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId}
List Timesheets
GET /api/v2/ess/{employeeId}/timesheet
Submit or Update Timesheet
POST /api/v2/ess/{employeeId}/timesheet
Bulk Decline Roster Shift Swaps
POST /api/v2/ess/{employeeId}/shift/swap/decline
Get Leaving employee form PDF
GET /api/v2/ess/{employeeId}/document/LeavingEmployeeForm
Get Locations
GET /api/v2/ess/{employeeId}/lookup/location
List Roster Shifts
GET /api/v2/ess/{employeeId}/shift
Propose Shift Swap
POST /api/v2/ess/{employeeId}/shift/swap/propose
Find Nearby Roster Shifts
GET /api/v2/ess/{employeeId}/shift/nearby
Get Expense Payment Summary
GET /api/v2/ess/{employeeId}/expense/summary
Register Device Token
POST /api/v2/ess/devicetoken/register
Acknowledge Document
POST /api/v2/ess/{employeeId}/document/acknowledge/{documentId}
Get Employee Profile Image
GET /api/v2/ess/{employeeId}/profileimage
Set Employee Profile Image
POST /api/v2/ess/{employeeId}/profileimage
Delete Employee Profile Image
DELETE /api/v2/ess/{employeeId}/profileimage
Accept Shift Swap
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/accept
Edit Timesheet
POST /api/v2/ess/{employeeId}/timesheet/{timesheetId}
Delete Timesheet
DELETE /api/v2/ess/{employeeId}/timesheet/{timesheetId}
Employees Eligible For Shift Swap
GET /api/v2/ess/{employeeId}/shift/{shiftId}/swap/candidates
List Pay Slips
GET /api/v2/ess/{employeeId}/document/payslip
Bulk Cancel Roster Shift Swaps
POST /api/v2/ess/{employeeId}/shift/swap/cancel
Get Lookup Data
GET /api/v2/ess/{employeeId}/timeandattendance/lookupdata
Get Business Titles
GET /api/v2/ess/{employeeId}/lookup/title
Bulk Accept Roster Shift Swaps
POST /api/v2/ess/{employeeId}/shift/swap/accept
List Leave Requests
GET /api/v2/ess/{employeeId}/leave
Create Leave Request
POST /api/v2/ess/{employeeId}/leave
List Unavailabilities
GET /api/v2/ess/{employeeId}/unavailability
Create Unavailability
POST /api/v2/ess/{employeeId}/unavailability
End Break
POST /api/v2/ess/{employeeId}/timeandattendance/endbreak
Get Emergency Contacts
GET /api/v2/ess/{employeeId}/emergencycontacts
Save Emergency Contacts
POST /api/v2/ess/{employeeId}/emergencycontacts
Download Document
GET /api/v2/ess/{employeeId}/document/download/{documentId}
Shifts
POST /api/v2/ess/{employeeId}/timeandattendance/shifts
Get Super Fund by ID
GET /api/v2/ess/{employeeId}/superfunds/{superFundId}
Get Expense Request by ID
GET /api/v2/ess/{employeeId}/expense/{expenseRequestId}
Update Expense Request
PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId}
Delete Expense Request
DELETE /api/v2/ess/{employeeId}/expense/{expenseRequestId}
Discard current shift
POST /api/v2/ess/{employeeId}/timeandattendance/discard
Get Roster Shift by ID
GET /api/v2/ess/{employeeId}/shift/{shiftId}
Get KiwiSaver options for employee
GET /api/v2/ess/{employeeId}/kiwisaver
Upload Attachment to Expense Request
PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId}/attachment
Unregister Device Token
POST /api/v2/ess/devicetoken/unregister
Get Satisfaction Survey Results
GET /api/v2/ess/{employeeId}/satisfaction
Submit Satisfaction Survey
POST /api/v2/ess/{employeeId}/satisfaction
Get Details
GET /api/v2/ess/{employeeId}/details
Save Details
POST /api/v2/ess/{employeeId}/details
Mark Shift Notes Read
POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes/read-state
Get Leave Categories
GET /api/v2/ess/{employeeId}/leave/leavecategories
Bulk Decline Roster Shifts
POST /api/v2/ess/{employeeId}/shift/decline
List all Documents
GET /api/v2/ess/{employeeId}/document
Get Dashboard
GET /api/v2/ess/{employeeId}/dashboard
Bulk Accept Roster Shifts
POST /api/v2/ess/{employeeId}/shift/accept
Get Payment Summary PDF
GET /api/v2/ess/{employeeId}/document/paymentsummary/{documentId}
Get Payment Summaries
GET /api/v2/ess/{employeeId}/document/paymentsummaries
Upload Attachment to Leave Request
PUT /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment
Delete Attachment from Leave Request
DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment
Find Matching Clock On Roster Shift
GET /api/v2/ess/{employeeId}/shift/matchingclockon
Delete Super Fund
DELETE /api/v2/ess/{employeeId}/superfunds/{superfundId}
Find Matching Clock Off Roster Shift
GET /api/v2/ess/{employeeId}/shift/matchingclockoff
Recover Forgotten Password
POST /api/v2/ess/security/forgottenpassword
Clock In Employee
POST /api/v2/ess/{employeeId}/timeandattendance/clockon
Accept Roster Shift
POST /api/v2/ess/{employeeId}/shift/{shiftId}/accept
Start Break
POST /api/v2/ess/{employeeId}/timeandattendance/startbreak
Update Super Fund
PUT /api/v2/ess/{employeeId}/superfunds/{id}
Get KiwiSaver Enrollment Options
GET /api/v2/ess/{employeeId}/lookup/enrollmentoptions
Get P60 certificate PDF
GET /api/v2/ess/{employeeId}/document/P60/{documentId}
Get unavailability by ID
GET /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}
Update Unavailability
PUT /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}
Delete Unavailability
DELETE /api/v2/ess/{employeeId}/unavailability/{unavailabilityId}
Estimate Leave Hours
GET /api/v2/ess/{employeeId}/leave/estimate
Get Employees
GET /api/v2/ess/security/employees
Get Enabled Features
GET /api/v2/ess/{employeeId}/security/features
Get P60 certificates
GET /api/v2/ess/{employeeId}/document/p60s
Get Pay Slip by Pay Run ID
GET /api/v2/ess/{employeeId}/document/payslip/{payrunId}
Get Expense Categories
GET /api/v2/ess/{employeeId}/expense/categories
Update Bank Account
PUT /api/v2/ess/{employeeId}/bankaccounts/{id}
Get Leave Balances
GET /api/v2/ess/{employeeId}/leave/balances
Get Bank Account by ID
GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}
Delete Bank Account
DELETE /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}