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