Description | HTTP Request |
---|---|
OAuth Token |
POST /oauth/token |
Single Sign On |
POST /api/v2/business/{businessId}/singlesignon |
Single Sign On |
POST /api/v2/business/{businessId}/employee/{employeeId}/singlesignon |
Single Sign On |
POST /api/v2/singlesignon |
Description | HTTP Request |
---|---|
Active Employees Report |
GET /api/v2/brand/{brandId}/reports/activeemployees |
Cancel Business |
DELETE /api/v2/brand/{brandId}/business/{businessId}/cancel |
Get Brand Label by ID |
GET /api/v2/brand/{id} |
List Brand Labels |
GET /api/v2/brand |
List Business Templates |
GET /api/v2/brand/{brandId}/business-templates |
Signup Report |
GET /api/v2/brand/{brandId}/reports/signups |
Description | HTTP Request |
---|---|
Assign Business Access |
POST /api/v2/business/{businessId}/access |
Change the tax year |
POST /api/v2/business/{businessId}/initialfinancialyear |
Copy Business Settings From Template |
POST /api/v2/business/{businessId}/{businessTemplateId} |
Create Business Document |
POST /api/v2/business/{businessId}/document |
Create New Business |
POST /api/v2/business |
Create new payment file record |
POST /api/v2/business/{businessId}/paymentfiles |
Create payslip configuration |
POST /api/v2/business/{businessId}/payslip |
Delete Business Document |
DELETE /api/v2/business/{businessId}/document/{id} |
Delete payment file record |
DELETE /api/v2/business/{businessId}/paymentfiles/{id} |
Dismiss Business Notifications |
DELETE /api/v2/business/{businessId}/actionitems/businessnotifications/{id}/dismiss |
Get Business Billing Plan |
GET /api/v2/business/{businessId}/subscription/currentbillingplan |
Get Business Details |
GET /api/v2/business/{businessId} |
Get Business Details by External ID |
GET /api/v2/business/externalid |
Get Business Document Content |
GET /api/v2/business/{businessId}/document/{id}/content |
Get Business Document Details |
GET /api/v2/business/{businessId}/document/{id} |
Get Employee Portal Settings |
GET /api/v2/business/{businessId}/employeeportalsettings |
Get Rounding Rules |
GET /api/v2/business/{businessId}/roundingrules |
Get Statutory Settings |
GET /api/v2/business/{businessId}/statutorysettings |
Get User Business Access |
GET /api/v2/business/{businessId}/access/user |
Get payment file by ID |
GET /api/v2/business/{businessId}/paymentfiles/{id} |
Get payslip configuration |
GET /api/v2/business/{businessId}/payslip |
Get the timesheet settings for the business |
GET /api/v2/business/{businessId}/timesheetsettings |
List All Business Access Users |
GET /api/v2/business/{businessId}/access |
List Billing Plans |
GET /api/v2/business/{businessId}/subscription/billingplans |
List Business Document Details |
GET /api/v2/business/{businessId}/document |
List Business Notifications |
GET /api/v2/business/{businessId}/actionitems/businessnotifications |
List Businesses |
GET /api/v2/business |
List Entitlements |
GET /api/v2/business/{businessId}/entitlements |
List payment files |
GET /api/v2/business/{businessId}/paymentfiles |
List the Business tags |
GET /api/v2/business/{businessId}/tags |
Revoke Business Access |
DELETE /api/v2/business/{businessId}/access |
Set Business Billing Plan |
POST /api/v2/business/{businessId}/subscription/setbillingplan |
Set Rounding Rules |
POST /api/v2/business/{businessId}/roundingrules |
Set Statutory Settings |
POST /api/v2/business/{businessId}/statutorysettings |
Update Business Details |
PUT /api/v2/business |
Update Business Document Permissions |
PUT /api/v2/business/{businessId}/document/{id} |
Update Employee Portal Settings |
POST /api/v2/business/{businessId}/employeeportalsettings |
Update details of an associated user |
PUT /api/v2/business/{businessId}/access |
Update payment file record |
PUT /api/v2/business/{businessId}/paymentfiles/{id} |
Update the timesheet settings for the business |
PUT /api/v2/business/{businessId}/timesheetsettings |
Description | HTTP Request |
---|---|
Bulk insert Journal Accounts |
POST /api/v2/business/{businessId}/accounts/bulk |
Create a new Journal Account |
POST /api/v2/business/{businessId}/accounts |
Delete Location Specific Chart of Accounts |
DELETE /api/v2/business/{businessId}/chartofaccounts/location/{locationId} |
Delete an existing Journal Account |
DELETE /api/v2/business/{businessId}/accounts/{id} |
Get Chart of Accounts |
GET /api/v2/business/{businessId}/chartofaccounts |
Get Journal Account Types |
GET /api/v2/business/{businessId}/accounts/types |
Get Journal Account by ID |
GET /api/v2/business/{businessId}/accounts/{id} |
Get Journal Accounts |
GET /api/v2/business/{businessId}/accounts |
Get Journal Service provider |
GET /api/v2/business/{businessId}/accounts/journalservice |
Get Journal Service providers |
GET /api/v2/business/{businessId}/accounts/journalservices |
Get Location Specific Chart of Accounts |
GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId} |
Update Chart of Accounts |
POST /api/v2/business/{businessId}/chartofaccounts |
Update Journal Service provider |
PUT /api/v2/business/{businessId}/accounts/journalservice |
Update Location Specific Chart of Accounts |
POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId} |
Update an existing Journal Account |
PUT /api/v2/business/{businessId}/accounts/{id} |
Description | HTTP Request |
---|---|
Create Deduction Category |
POST /api/v2/business/{businessId}/deductioncategory |
Delete Deduction Category |
DELETE /api/v2/business/{businessId}/deductioncategory/{id} |
Get Deduction Category By ID |
GET /api/v2/business/{businessId}/deductioncategory/{id} |
List Deduction Categories |
GET /api/v2/business/{businessId}/deductioncategory |
Update Deduction Category |
PUT /api/v2/business/{businessId}/deductioncategory/{id} |
Description | HTTP Request |
---|---|
Create Dimension |
POST /api/v2/business/{businessId}/dimension |
Create Dimension Value |
POST /api/v2/business/{businessId}/dimension/{dimensionId}/value |
Delete Dimension |
DELETE /api/v2/business/{businessId}/dimension/{id} |
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} |
Get Dimension by ID |
GET /api/v2/business/{businessId}/dimension/{id} |
List Dimension Values |
GET /api/v2/business/{businessId}/dimension/{dimensionId}/value |
List Dimensions |
GET /api/v2/business/{businessId}/dimension |
Update Dimension |
PUT /api/v2/business/{businessId}/dimension/{id} |
Update Dimension Value |
PUT /api/v2/business/{businessId}/dimension/{dimensionId}/value/{id} |
Description | HTTP Request |
---|---|
Activate Employee |
POST /api/v2/business/{businessId}/employee/activate/{employeeId} |
Create or Update Employee |
POST /api/v2/business/{businessId}/employee/unstructured |
Delete Employee |
DELETE /api/v2/business/{businessId}/employee/{employeeId} |
Delete Employee Profile Image |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/image |
Get Employee By External ID |
GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId} |
Get Employee By External Reference ID |
GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source} |
Get Employee By ID |
GET /api/v2/business/{businessId}/employee/unstructured/{employeeId} |
Get Employee Notes |
GET /api/v2/business/{businessId}/employee/{employeeId}/notes |
Get Employee Profile Image |
GET /api/v2/business/{businessId}/employee/{employeeId}/image |
Get Employee Shift Conditions |
GET /api/v2/business/{businessId}/employee/{employeeId}/shiftcondition |
Get Employee Work Types |
GET /api/v2/business/{businessId}/employee/{employeeId}/worktype |
Get Employee basic details by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/details |
Get Leave Balances |
GET /api/v2/business/{businessId}/employee/{employeeId}/leavebalances |
Get Opening Balances |
GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances |
Get Pay Rates |
GET /api/v2/business/{businessId}/employee/{employeeId}/payrate |
Get standard hours for employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/standardhours |
Grant Kiosk Access |
POST /api/v2/business/{businessId}/employee/grantkioskaccess/{employeeId} |
List Employees |
GET /api/v2/business/{businessId}/employee/unstructured |
List basic details for employees |
GET /api/v2/business/{businessId}/employee/details |
Revoke Kiosk Access |
POST /api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId} |
Set Employee Notes |
POST /api/v2/business/{businessId}/employee/{employeeId}/notes |
Set Employee Profile Image |
POST /api/v2/business/{businessId}/employee/{employeeId}/image |
Set Opening Balances |
POST /api/v2/business/{businessId}/employee/{employeeId}/openingbalances |
Set standard hours for employee |
PUT /api/v2/business/{businessId}/employee/{employeeId}/standardhours |
Update Employee |
PUT /api/v2/business/{businessId}/employee/unstructured/{employeeId} |
Description | HTTP Request |
---|---|
Get Employee Access for User |
GET /api/v2/business/{businessId}/employee/{employeeId}/access/email |
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 |
Description | HTTP Request |
---|---|
Create Bank Account |
POST /api/v2/business/{businessId}/employee/{employeeId}/bankaccount |
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} |
List Bank Accounts |
GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount |
Update Bank Account |
PUT /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{id} |
Description | HTTP Request |
---|---|
Create Employee Document |
POST /api/v2/business/{businessId}/employee/{employeeId}/document |
Delete Employee Document |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{id} |
Get Employee Document Content |
GET /api/v2/business/{businessId}/employee/{employeeId}/document/{id}/content |
Get Employee Document Details |
GET /api/v2/business/{businessId}/employee/{employeeId}/document/{id} |
Link Employee Document to Expense Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/expense/{id} |
Link Employee Document to Leave Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/leave/{id} |
Link Employee Document to Timesheet |
POST /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/timesheet/{id} |
List Employee Documents |
GET /api/v2/business/{businessId}/employee/{employeeId}/document |
Unlink Employee Document from Expense Request |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/expense/{id} |
Unlink Employee Document from Leave Request |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/leave/{id} |
Unlink Employee Document from Timesheet |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/timesheet/{id} |
Update Employee Document Permissions |
PUT /api/v2/business/{businessId}/employee/{employeeId}/document |
Description | HTTP Request |
---|---|
Create Earnings line split |
POST /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit |
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} |
Get Employee location earnings line splits |
GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit |
Update Earnings line split |
PUT /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/{locationId} |
Description | HTTP Request |
---|---|
Create Employee Expense Category |
POST /api/v2/business/{businessId}/employeeexpensecategory |
Delete Employee Expense Category |
DELETE /api/v2/business/{businessId}/employeeexpensecategory/{id} |
Get Employee Expense Category by ID |
GET /api/v2/business/{businessId}/employeeexpensecategory/{id} |
Get Tax Codes |
GET /api/v2/business/{businessId}/employeeexpensecategory/taxcodes |
List Employee Expense Categories |
GET /api/v2/business/{businessId}/employeeexpensecategory |
Update Employee Expense Category |
PUT /api/v2/business/{businessId}/employeeexpensecategory/{id} |
Description | HTTP Request |
---|---|
Approve Expense Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/approve |
Create Expense Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest |
Decline Expense Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/decline |
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} |
List Expense Requests |
GET /api/v2/business/{businessId}/employee/{employeeId}/expenserequest |
Update Expense Request |
PUT /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId} |
Upload Attachment to Expense Request |
PUT /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/attachment |
Description | HTTP Request |
---|---|
Create Employee Group |
POST /api/v2/business/{businessId}/employeegroup |
Delete Employee Group |
DELETE /api/v2/business/{businessId}/employeegroup/{id} |
Get Employee Group by ID |
GET /api/v2/business/{businessId}/employeegroup/{id} |
List Employee Groups |
GET /api/v2/business/{businessId}/employeegroup |
Update Employee Group |
PUT /api/v2/business/{businessId}/employeegroup/{id} |
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 |
Description | HTTP Request |
---|---|
Initiate Employee Self Setup |
POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice |
Description | HTTP Request |
---|---|
Create pay rate adjustment schedule record |
POST /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule |
Delete pay rate adjustment schedule record |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{id} |
Get pay rate adjustment schedule record by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{recordId} |
List pay rate adjustment schedule |
GET /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule |
Update pay rate adjustment schedule record |
PUT /api/v2/business/{businessId}/employee/{employeeId}/payrateschedule/{id} |
Description | HTTP Request |
---|---|
Add/Update Employee Qualification |
POST /api/v2/business/{businessId}/employee/{employeeId}/qualification |
Create Employee Qualification Document |
POST /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document |
Delete Employee Qualification |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification |
Delete Employee Qualification Document |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id} |
Get Qualification Details |
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id} |
Get Qualification Document File |
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id}/content |
Get Qualification Document by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id} |
Get Qualifications for Employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification |
List Documents for Employee Qualification |
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document |
Description | HTTP Request |
---|---|
Create Dimension Earnings Line Split |
POST /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension |
Delete Dimension Earnings Line Split |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension/{dimensionId}/value/{dimensionValueId} |
Get Employee Dimension Earnings Line Split By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/earningslinesplit/dimension/{dimensionId}/value/{dimensionValueId} |
Get 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 |
Description | HTTP Request |
---|---|
GET /api/v2/ess/{employeeId}/document/eaform/{documentId} |
|
GET /api/v2/ess/{employeeId}/lookup/addresses/{suburbId} |
|
GET /api/v2/ess/{employeeId}/document/pcb2forms |
|
GET /api/v2/ess/{employeeId}/document/pcb2forms/swagrequired2fa |
|
GET /api/v2/ess/{employeeId}/document/pcb2form/{documentId} |
|
GET /api/v2/ess/{employeeId}/document/eaform/{documentId}/swagrequired2fa |
|
GET /api/v2/ess/{employeeId}/document/pcb2form/{documentId}/swagrequired2fa |
|
Accept Roster Shift |
POST /api/v2/ess/{employeeId}/shift/{shiftId}/accept |
Accept Shift Swap |
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/accept |
Acknowledge Document |
POST /api/v2/ess/{employeeId}/document/acknowledge/{documentId} |
Add Employee Qualification |
POST /api/v2/ess/{employeeId}/qualification |
Add Note to Shift |
POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes |
Bulk Accept Roster Shift Swaps |
POST /api/v2/ess/{employeeId}/shift/swap/accept |
Bulk Accept Roster Shifts |
POST /api/v2/ess/{employeeId}/shift/accept |
Bulk Cancel Roster Shift Swaps |
POST /api/v2/ess/{employeeId}/shift/swap/cancel |
Bulk Decline Roster Shift Swaps |
POST /api/v2/ess/{employeeId}/shift/swap/decline |
Bulk Decline Roster Shifts |
POST /api/v2/ess/{employeeId}/shift/decline |
Cancel Shift Swap |
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/cancel |
Clock In Employee |
POST /api/v2/ess/{employeeId}/timeandattendance/clockon |
Clock Out Employee |
POST /api/v2/ess/{employeeId}/timeandattendance/clockoff |
Create Bank Account |
POST /api/v2/ess/{employeeId}/bankaccounts |
Create Bank Account |
POST /api/v2/ess/{employeeId}/bankaccounts/swagrequired2fa |
Create Expense Request |
POST /api/v2/ess/{employeeId}/expense |
Create Leave Request |
POST /api/v2/ess/{employeeId}/leave |
Create Unavailability |
POST /api/v2/ess/{employeeId}/unavailability |
Decline Roster Shift |
POST /api/v2/ess/{employeeId}/shift/{shiftId}/decline |
Decline Shift Swap |
POST /api/v2/ess/{employeeId}/shift/{shiftId}/swap/decline |
Delete Attachment from Leave Request |
DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment |
Delete Bank Account |
DELETE /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId} |
Delete Bank Account |
DELETE /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}/swagrequired2fa |
Delete Employee Profile Image |
DELETE /api/v2/ess/{employeeId}/profileimage |
Delete Employee Qualification |
DELETE /api/v2/ess/{employeeId}/qualification/{id} |
Delete Expense Request |
DELETE /api/v2/ess/{employeeId}/expense/{expenseRequestId} |
Delete Leave Request |
DELETE /api/v2/ess/{employeeId}/leave/{leaveRequestId} |
Delete Timesheet |
DELETE /api/v2/ess/{employeeId}/timesheet/{timesheetId} |
Delete Unavailability |
DELETE /api/v2/ess/{employeeId}/unavailability/{unavailabilityId} |
Delete attachment from EmployeeQualification |
DELETE /api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment/{documentId} |
Discard current shift |
POST /api/v2/ess/{employeeId}/timeandattendance/discard |
Download Document |
GET /api/v2/ess/{employeeId}/document/download/{documentId} |
Edit Timesheet |
POST /api/v2/ess/{employeeId}/timesheet/{timesheetId} |
Employees Eligible For Shift Swap |
GET /api/v2/ess/{employeeId}/shift/{shiftId}/swap/candidates |
End Break |
POST /api/v2/ess/{employeeId}/timeandattendance/endbreak |
Estimate Leave Hours |
GET /api/v2/ess/{employeeId}/leave/estimate |
Find Matching Clock Off Roster Shift |
GET /api/v2/ess/{employeeId}/shift/matchingclockoff |
Find Matching Clock On Roster Shift |
GET /api/v2/ess/{employeeId}/shift/matchingclockon |
Find Nearby Roster Shifts |
GET /api/v2/ess/{employeeId}/shift/nearby |
Get Bank Account by ID |
GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}/swagrequired2fa |
Get Bank Account by ID |
GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId} |
Get Dashboard |
GET /api/v2/ess/{employeeId}/dashboard |
Get Details |
GET /api/v2/ess/{employeeId}/details |
Get Document Details by ID |
GET /api/v2/ess/{employeeId}/document/{documentId} |
Get EA Forms |
GET /api/v2/ess/{employeeId}/document/eaforms/swagrequired2fa |
Get EA Forms |
GET /api/v2/ess/{employeeId}/document/eaforms |
Get Emergency Contacts |
GET /api/v2/ess/{employeeId}/emergencycontacts |
Get Employee Profile Image |
GET /api/v2/ess/{employeeId}/profileimage |
Get Employees |
GET /api/v2/ess/security/employees |
Get Enabled Features |
GET /api/v2/ess/{employeeId}/security/features |
Get Expense Categories |
GET /api/v2/ess/{employeeId}/expense/categories |
Get Expense Payment Summary |
GET /api/v2/ess/{employeeId}/expense/summary |
Get Expense Request by ID |
GET /api/v2/ess/{employeeId}/expense/{expenseRequestId} |
Get Expense Requests |
GET /api/v2/ess/{employeeId}/expense |
Get Leave Balances |
GET /api/v2/ess/{employeeId}/leave/balances |
Get Leave Categories |
GET /api/v2/ess/{employeeId}/leave/leavecategories |
Get Leave Request by ID |
GET /api/v2/ess/{employeeId}/leave/{leaveRequestId} |
Get Locations |
GET /api/v2/ess/{employeeId}/lookup/location |
Get Lookup Data |
GET /api/v2/ess/{employeeId}/timeandattendance/lookupdata |
Get Pay Slip by Pay Run ID |
GET /api/v2/ess/{employeeId}/document/payslip/{payrunId} |
Get Personal Details |
GET /api/v2/ess/{employeeId}/personaldetails |
Get Qualification Details |
GET /api/v2/ess/{employeeId}/qualification/{id} |
Get Qualifications for Employee |
GET /api/v2/ess/{employeeId}/qualification |
Get Roster Shift by ID |
GET /api/v2/ess/{employeeId}/shift/{shiftId} |
Get Satisfaction Survey Results |
GET /api/v2/ess/{employeeId}/satisfaction |
Get Shift Conditions |
GET /api/v2/ess/{employeeId}/lookup/shiftcondition |
Get Shift Notes |
GET /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes |
Get Suburb |
GET /api/v2/ess/{employeeId}/lookup/suburb |
Get Tax Codes |
GET /api/v2/ess/{employeeId}/expense/taxcodes |
Get Timesheet Creation Data |
GET /api/v2/ess/{employeeId}/timesheet/data |
Get Titles |
GET /api/v2/ess/{employeeId}/lookup/title |
Get Work Types |
GET /api/v2/ess/{employeeId}/lookup/worktype |
Get public holidays |
GET /api/v2/ess/{employeeId}/publicHolidays |
Get unavailability by ID |
GET /api/v2/ess/{employeeId}/unavailability/{unavailabilityId} |
List Bank Accounts |
GET /api/v2/ess/{employeeId}/bankaccounts |
List Bank Accounts |
GET /api/v2/ess/{employeeId}/bankaccounts/swagrequired2fa |
List Leave Requests |
GET /api/v2/ess/{employeeId}/leave |
List Pay Slips |
GET /api/v2/ess/{employeeId}/document/payslip |
List Pay Slips |
GET /api/v2/ess/{employeeId}/document/payslip/swagrequired2fa |
List Roster Shifts |
GET /api/v2/ess/{employeeId}/shift |
List Timesheets |
GET /api/v2/ess/{employeeId}/timesheet |
List Unavailabilities |
GET /api/v2/ess/{employeeId}/unavailability |
List all Documents |
GET /api/v2/ess/{employeeId}/document |
Mark Shift Notes Read |
POST /api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes/read-state |
Propose Shift Swap |
POST /api/v2/ess/{employeeId}/shift/swap/propose |
Recover Forgotten Password |
POST /api/v2/ess/security/forgottenpassword |
Register Device Token |
POST /api/v2/ess/devicetoken/register |
Save Details |
POST /api/v2/ess/{employeeId}/details |
Save Emergency Contacts |
POST /api/v2/ess/{employeeId}/emergencycontacts |
Search Suburbs |
GET /api/v2/ess/{employeeId}/lookup/suburbs |
Set Employee Profile Image |
POST /api/v2/ess/{employeeId}/profileimage |
Shifts |
POST /api/v2/ess/{employeeId}/timeandattendance/shifts |
Start Break |
POST /api/v2/ess/{employeeId}/timeandattendance/startbreak |
Submit Satisfaction Survey |
POST /api/v2/ess/{employeeId}/satisfaction |
Submit or Update Timesheet |
POST /api/v2/ess/{employeeId}/timesheet |
Unregister Device Token |
POST /api/v2/ess/devicetoken/unregister |
Update Bank Account |
PUT /api/v2/ess/{employeeId}/bankaccounts/{id}/swagrequired2fa |
Update Bank Account |
PUT /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}/swagrequired2fa |
Update Bank Account |
PUT /api/v2/ess/{employeeId}/bankaccounts/{id} |
Update Bank Account |
PUT /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId} |
Update Emergency Contacts |
PUT /api/v2/ess/{employeeId}/emergencycontacts |
Update Employee Qualification |
PUT /api/v2/ess/{employeeId}/qualification/{id} |
Update Expense Request |
PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId} |
Update Leave Request |
POST /api/v2/ess/{employeeId}/leave/{leaveRequestId} |
Update Personal Details |
PUT /api/v2/ess/{employeeId}/personaldetails |
Update Unavailability |
PUT /api/v2/ess/{employeeId}/unavailability/{unavailabilityId} |
Upload Attachment to Expense Request |
PUT /api/v2/ess/{employeeId}/expense/{expenseRequestId}/attachment |
Upload Attachment to Leave Request |
PUT /api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment |
Upload attachment to qualification |
PUT /api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment |
Description | HTTP Request |
---|---|
Create Employer Liability Category |
POST /api/v2/business/{businessId}/employerliabilitycategory |
Delete Employer Liability Category |
DELETE /api/v2/business/{businessId}/employerliabilitycategory/{id} |
Get Employer Liability Category |
GET /api/v2/business/{businessId}/employerliabilitycategory/{id} |
List Employer Liability Categories |
GET /api/v2/business/{businessId}/employerliabilitycategory |
Update Employer Liability Category |
PUT /api/v2/business/{businessId}/employerliabilitycategory/{id} |
Description | HTTP Request |
---|---|
Create Employing Entity |
POST /api/v2/business/{businessId}/employingentity |
Delete Employing Entity |
DELETE /api/v2/business/{businessId}/employingentity/{id} |
Get Employing Entity By ID |
GET /api/v2/business/{businessId}/employingentity/{id} |
List Employing Entities |
GET /api/v2/business/{businessId}/employingentity |
Update Employing Entity |
PUT /api/v2/business/{businessId}/employingentity/{id} |
Description | HTTP Request |
---|---|
Get Shift Costings for Employee |
POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftcosting |
Get Shift Periods for Employee |
POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods |
Description | HTTP Request |
---|---|
Get Brand Invoice By ID |
GET /api/v2/brand/{brandId}/Invoice/{id} |
Get Brand Invoice Excel By ID |
GET /api/v2/brand/{brandId}/Invoice/{id}/excel |
Get Brand Invoice PDF By ID |
GET /api/v2/brand/{brandId}/Invoice/{id}/pdf |
Get Brand Invoices |
GET /api/v2/brand/{brandId}/Invoice |
Get Business Invoice By ID |
GET /api/v2/business/{businessId}/Invoice/{id} |
Get Business Invoice PDF By ID |
GET /api/v2/business/{businessId}/Invoice/{id}/pdf |
Get Business Invoices |
GET /api/v2/business/{businessId}/Invoice |
Get Reseller Invoice By ID |
GET /api/v2/reseller/{resellerId}/Invoice/{id} |
Get Reseller Invoice Excel By ID |
GET /api/v2/reseller/{resellerId}/Invoice/{id}/excel |
Get Reseller Invoice PDF By ID |
GET /api/v2/reseller/{resellerId}/Invoice/{id}/pdf |
Get Reseller Invoices |
GET /api/v2/reseller/{resellerId}/Invoice |
Description | HTTP Request |
---|---|
Assign Leave Allowance Template |
POST /api/v2/business/{businessId}/employee/{employeeId}/leaveallowancetemplate/assign/{leaveAllowanceTemplateId} |
Create Leave Allowance Template |
POST /api/v2/business/{businessId}/leaveallowancetemplate |
Delete Leave Allowance Template |
DELETE /api/v2/business/{businessId}/leaveallowancetemplate/{id} |
Get Leave Allowance Template by ID |
GET /api/v2/business/{businessId}/leaveallowancetemplate/{id} |
Get Leave Allowance Template for Employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/leaveallowancetemplate |
Get Leave Allowances for All Employees |
GET /api/v2/business/{businessId}/leaveallowances |
Get Leave Allowances for Employee |
GET /api/v2/business/{businessId}/leaveallowances/{employeeId} |
List Leave Allowance Templates |
GET /api/v2/business/{businessId}/leaveallowancetemplate |
Reapply Leave Allowance Template |
POST /api/v2/business/{businessId}/leaveallowancetemplate/reapply/{id} |
Set Leave Allowances |
PUT /api/v2/business/{businessId}/leaveallowances |
Update Leave Allowance Template |
PUT /api/v2/business/{businessId}/leaveallowancetemplate/{id} |
Description | HTTP Request |
---|---|
Create Leave Category |
POST /api/v2/business/{businessId}/leavecategory |
Delete Leave Category |
DELETE /api/v2/business/{businessId}/leavecategory/{id} |
Get Leave Category by ID |
GET /api/v2/business/{businessId}/leavecategory/{id} |
List Leave Categories |
GET /api/v2/business/{businessId}/leavecategory |
Update Leave Category |
PUT /api/v2/business/{businessId}/leavecategory/{id} |
Description | HTTP Request |
---|---|
Approve Leave Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve |
Create Leave Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest |
Decline Leave Request |
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline |
Delete Leave Request |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId} |
Estimate Leave Units |
GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/estimate |
Get Leave Request by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId} |
Get Leave Requests for Employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest |
List Leave Requests |
GET /api/v2/business/{businessId}/leaverequest |
Update Leave Request |
PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest |
Update Leave Request |
PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId} |
Description | HTTP Request |
---|---|
Create Location |
POST /api/v2/business/{businessId}/location |
Delete Location |
DELETE /api/v2/business/{businessId}/location/{id} |
Get Location By Id |
GET /api/v2/business/{businessId}/location/{id} |
List Business Locations |
GET /api/v2/business/{businessId}/location |
List Employee Locations |
GET /api/v2/business/{businessId}/employee/{employeeId}/location |
Update Location |
PUT /api/v2/business/{businessId}/location/{id} |
Description | HTTP Request |
---|---|
List Employee Group Permission Types |
GET /api/v2/lookupdata/employeegrouppermissions |
List Report Types |
GET /api/v2/lookupdata/reports |
List Time Zone Types |
GET /api/v2/lookupdata/timezones |
List Time Zone Types |
GET /api/v2/business/{businessId}/lookupdata/timezones |
List countries |
GET /api/v2/lookupdata/countries |
List gender options |
GET /api/v2/lookupdata/genders |
List industry options |
GET /api/v2/lookupdata/industries |
Description | HTTP Request |
---|---|
Add Note to Shift |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes |
Add an Employee |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff |
Approve Expense Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/approve |
Approve Leave Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/approve |
Approve Timesheet |
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/approve |
Change PIN |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/changepin |
Check Employee |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkid |
Clock In Employee |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockon |
Clock Out Employee |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockoff |
Create Leave Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest |
Create Unavailability |
POST /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability |
Create expense request |
POST /api/v2/business/{businessId}/manager/{employeeId}/expense |
Create kiosk timesheet line |
POST /api/v2/business/{businessId}/manager/kiosk/timesheet |
Create roster shift |
POST /api/v2/business/{businessId}/manager/rostershift |
Create timesheet line |
POST /api/v2/business/{businessId}/manager/timesheet |
Decline Expense Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/decline |
Decline Leave Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/decline |
Delete Employee Profile Image |
DELETE /api/v2/business/{businessId}/manager/employee/{employeeId}/image |
Delete Expense Request |
DELETE /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId} |
Delete Leave Request |
DELETE /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId} |
Delete Note from Shift |
DELETE /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId} |
Delete Timesheet |
DELETE /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId} |
Delete Unavailability |
DELETE /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId} |
Discard current shift |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/discard |
Download Document |
GET /api/v2/business/{businessId}/manager/{employeeId}/document/download/{documentId} |
Edit Expense Request |
PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId} |
Edit Timesheet |
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId} |
End Break |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/endbreak |
Estimate Leave Hours |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/estimate |
Find Matching Clock Off Roster Shift |
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockoff |
Find Matching Clock On Roster Shift |
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockon |
Find Nearby Roster Shifts |
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/nearby |
Get Business Expense Requests |
GET /api/v2/business/{businessId}/manager/expense |
Get Business Timesheets |
GET /api/v2/business/{businessId}/manager/timesheet |
Get Business Timesheets |
GET /api/v2/business/{businessId}/manager/kiosk/timesheet |
Get Dashboard |
GET /api/v2/business/{businessId}/manager/dashboard |
Get Employee Lookup Data |
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/lookupdata/{employeeId} |
Get Employee Profile Image |
GET /api/v2/business/{businessId}/manager/employee/{employeeId}/image |
Get Kiosk by ID |
GET /api/v2/business/{businessId}/manager/kiosk/{id} |
Get Kiosks |
GET /api/v2/business/{businessId}/manager/kiosk |
Get Leave Balances |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/balances |
Get Leave Request Attachment |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/attachment |
Get Leave Request by ID |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId} |
Get List of Employees |
GET /api/v2/business/{businessId}/manager/employees |
Get List of Locations |
GET /api/v2/business/{businessId}/manager/locations |
Get Roster Shift by ID |
GET /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId} |
Get Roster Shifts |
GET /api/v2/business/{businessId}/manager/rostershift |
Get Rounding Rules |
GET /api/v2/business/{businessId}/manager/roundingrules |
Get Shift Notes |
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes |
Get expense request |
GET /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId} |
Get expenses reference data |
GET /api/v2/business/{businessId}/manager/{employeeId}/expense/reference |
Get the list of roles available |
GET /api/v2/business/{businessId}/manager/rostershift/roles |
Get timesheet |
GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId} |
Get timesheet reference data |
GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/reference |
Initiate Employee Self Setup |
POST /api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice |
List Businesses |
GET /api/v2/manager/security/businesses |
List Employee Groups |
GET /api/v2/business/{businessId}/manager/timesheet/employeegroups |
List Employee Locations |
GET /api/v2/business/{businessId}/manager/employee/{employeeId}/location |
List Employee Locations |
GET /api/v2/business/{businessId}/manager/location |
List Expense Categories |
GET /api/v2/business/{businessId}/manager/expense/categories |
List Expense Request Employees |
GET /api/v2/business/{businessId}/manager/expense/employees |
List Expense Request Locations |
GET /api/v2/business/{businessId}/manager/expense/locations |
List Kiosk Staff |
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff |
List Leave Categories |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/categories |
List Leave Categories |
GET /api/v2/business/{businessId}/manager/leaverequest/categories |
List Leave Employees |
GET /api/v2/business/{businessId}/manager/leaverequest/employees |
List Leave Locations |
GET /api/v2/business/{businessId}/manager/leaverequest/locations |
List Leave Requests |
GET /api/v2/business/{businessId}/manager/leaverequest |
List Manager Roster Employees |
GET /api/v2/business/{businessId}/manager/rostershift/manageemployees |
List Roster Employees |
GET /api/v2/business/{businessId}/manager/rostershift/employees |
List Roster Locations |
GET /api/v2/business/{businessId}/manager/rostershift/locations |
List Tax Codes |
GET /api/v2/business/{businessId}/manager/expense/taxcodes |
List Timesheet Employees |
GET /api/v2/business/{businessId}/manager/timesheet/employees |
List Timesheet Locations |
GET /api/v2/business/{businessId}/manager/timesheet/locations |
Manage Roster Data |
GET /api/v2/business/{businessId}/manager/rostershift/manage |
Mark Shift Notes Read |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/read-state |
Overlapping Leave Requests |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/overlapping |
Overlapping Leave Requests |
GET /api/v2/business/{businessId}/manager/leaverequest/overlapping |
Reject Timesheet |
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/reject |
Send PIN Reset Email |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/emailreset |
Send PIN Reset SMS |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/smsreset |
Set Employee Profile Image |
POST /api/v2/business/{businessId}/manager/employee/{employeeId}/image |
Set Rounding Rules |
POST /api/v2/business/{businessId}/manager/roundingrules |
Shifts |
POST /api/v2/business/{businessId}/manager/kiosk/shifts |
Start Break |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/startbreak |
Stub Shift Timesheets |
POST /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}/stub |
Update Leave Request |
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId} |
Update Unavailability |
PUT /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId} |
Update comments in a timesheet |
PUT /api/v2/business/{businessId}/manager/kiosk/timesheetcomments/{timesheetLineId} |
Update kiosk timesheet line |
PUT /api/v2/business/{businessId}/manager/kiosk/timesheet/{timesheetLineId} |
Update roster shift |
PUT /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId} |
Update timesheet line |
PUT /api/v2/business/{businessId}/manager/timesheet/{timesheetLineId} |
Upload Attachment to Expense Request |
PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/attachment |
Verify Kiosk PIN |
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkpin |
Description | HTTP Request |
---|---|
Create Pay Category |
POST /api/v2/business/{businessId}/paycategory |
Delete Pay Category |
DELETE /api/v2/business/{businessId}/paycategory/{id} |
Get Pay Category by ID |
GET /api/v2/business/{businessId}/paycategory/{id} |
List Pay Categories |
GET /api/v2/business/{businessId}/paycategory |
Update Pay Category |
PUT /api/v2/business/{businessId}/paycategory/{id} |
Description | HTTP Request |
---|---|
Create Pay Rate Template |
POST /api/v2/business/{businessId}/payratetemplate |
Delete Pay Rate Template |
DELETE /api/v2/business/{businessId}/payratetemplate/{id} |
Get Pay Rate Template by ID |
GET /api/v2/business/{businessId}/payratetemplate/{id} |
List Pay Rate Templates |
GET /api/v2/business/{businessId}/payratetemplate |
Update Pay Rate Template |
PUT /api/v2/business/{businessId}/payratetemplate/{id} |
Description | HTTP Request |
---|---|
Bulk Apply Leave Requests |
POST /api/v2/business/{businessId}/payrun/{payRunId}/bulkapplyleaverequests |
Create Deductions |
POST /api/v2/business/{businessId}/payrun/{payRunId}/deductions |
Create Earnings Lines |
POST /api/v2/business/{businessId}/payrun/{payRunId}/earningslines |
Create Employee Expenses |
POST /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses |
Create Employer Liabilities |
POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities |
Create Note for Employee |
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId} |
Create Pay Run |
POST /api/v2/business/{businessId}/payrun |
Create Pay Run (Async) |
POST /api/v2/business/{businessId}/payrun/async |
Delete Deduction |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/deductions |
Delete Earnings Line |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/earningslines |
Delete Employee Expense |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses |
Delete Employer Liability |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities |
Delete Leave Accrual |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued |
Delete Note for Employee |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId} |
Delete Pay Run |
DELETE /api/v2/business/{businessId}/payrun/{payRunId} |
Delete Pay Run Notation |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation |
Finalise Pay Run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise |
Get Creation Status |
GET /api/v2/business/{businessId}/payrun/creationstatus/{jobId} |
Get Deductions by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId} |
Get Earnings Lines by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId} |
Get Employee Expenses by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId} |
Get Employer Liabilities by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId} |
Get Journal Details |
GET /api/v2/business/{businessId}/journal/{payRunId} |
Get Leave Accruals |
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued |
Get Leave Accruals for Employee |
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId} |
Get Pay Run |
GET /api/v2/business/{businessId}/payrun/{payRunId} |
Get Pay Run Summary |
GET /api/v2/business/{businessId}/payrun/{payRunId}/summary |
Get Pay Run Totals by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId} |
Get Pay Slip Data by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId} |
Get Pay Slip File |
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId} |
Get pay run payments |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payments |
Include Employee |
POST /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId} |
List Deductions |
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions |
List Earnings Lines |
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines |
List Employee Expenses |
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses |
List Employer Liabilities |
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities |
List Pay Run Totals |
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals |
List Pay Run Totals for Employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/payruntotals |
List Pay Run Warnings |
GET /api/v2/business/{businessId}/payrun/{payRunId}/warnings |
List Pay Runs |
GET /api/v2/business/{businessId}/payrun |
List Pay Runs Summaries |
GET /api/v2/business/{businessId}/payrun/summary |
List Pay Slip Data |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips |
Net to Gross |
POST /api/v2/business/{businessId}/payrun/{payRunId}/nettogross |
Recalculate |
POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate |
Remove Employee from Pay Run |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId} |
Save Leave Accruals |
POST /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued |
Set Pay Run Notation |
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation |
Set UI Unlock enabled |
POST /api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate |
Start Approval Process |
POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start |
Start Payment Approval Process |
GET /api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start |
Terminate Employee in Pay Run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/terminate |
Unlock Pay Run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/unlock |
Description | HTTP Request |
---|---|
Create Employee Additional Earning |
POST /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings |
Create Employee Benefits In Kind Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment |
Create Employee Deduction |
POST /api/v2/business/{businessId}/employee/{employeeId}/deduction |
Create Employee Expense |
POST /api/v2/business/{businessId}/employee/{employeeId}/expense |
Create Employee Statutory Contribution Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment |
Create Employee Tax Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment |
Create Employee Tax Relief Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment |
Create Employer liability |
POST /api/v2/business/{businessId}/employee/{employeeId}/employerliability |
Delete Employee Additional Earning |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id} |
Delete Employee Benefits In Kind Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id} |
Delete Employee Deduction |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id} |
Delete Employee Expense |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/expense/{id} |
Delete Employee Statutory Contribution Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id} |
Delete Employee Tax Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id} |
Delete Employee Tax Relief Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id} |
Delete Employer liability |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id} |
Get Employee Additional Earning by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id} |
Get Employee Benefits In Kind Adjustment by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id} |
Get Employee Deduction by External Reference Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/deduction/{externalReferenceId} |
Get Employee Deduction by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id} |
Get Employee Expense by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/expense/{id} |
Get Employee Statutory Contribution Adjustment by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id} |
Get Employee Tax Adjustment by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id} |
Get Employee Tax Relief Adjustment by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id} |
Get Employer liability by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id} |
List Employee Additional Earnings |
GET /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings |
List Employee Benefits In Kind Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment |
List Employee Deductions |
GET /api/v2/business/{businessId}/employee/{employeeId}/deduction |
List Employee Deductions By External Reference Id |
POST /api/v2/business/{businessId}/employee/deduction |
List Employee Expenses |
GET /api/v2/business/{businessId}/employee/{employeeId}/expense |
List Employee Statutory Contribution Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment |
List Employee Tax Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment |
List Employee Tax Relief Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment |
List Employer liabilities |
GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability |
Update Employee Additional Earning |
PUT /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{id} |
Update Employee Benefits In Kind Adjustment |
PUT /api/v2/business/{businessId}/employee/{employeeId}/benefitsinkindadjustment/{id} |
Update Employee Deduction |
PUT /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id} |
Update Employee Expense |
PUT /api/v2/business/{businessId}/employee/{employeeId}/expense/{id} |
Update Employee Statutory Contribution Adjustment |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutorycontributionadjustment/{id} |
Update Employee Tax Adjustment |
PUT /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id} |
Update Employee Tax Relief Adjustment |
PUT /api/v2/business/{businessId}/employee/{employeeId}/taxreliefadjustment/{id} |
Update Employer liability |
PUT /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id} |
Description | HTTP Request |
---|---|
Create Pay Schedule |
POST /api/v2/business/{businessId}/payschedule |
Delete Pay Schedule |
DELETE /api/v2/business/{businessId}/payschedule/{id} |
Get Next Pay Date |
GET /api/v2/business/{businessId}/payschedule/{payScheduleId}/nextpaydate |
Get Pay Schedule Metadata |
GET /api/v2/business/{businessId}/payschedule/metadata |
Get Pay Schedule by ID |
GET /api/v2/business/{businessId}/payschedule/{id} |
List Next Pay Dates |
GET /api/v2/business/{businessId}/payschedule/nextpaydates |
List Pay Schedules |
GET /api/v2/business/{businessId}/payschedule |
Update Pay Schedule |
PUT /api/v2/business/{businessId}/payschedule/{id} |
Description | HTTP Request |
---|---|
Add a public holiday |
POST /api/v2/business/{businessId}/publicholiday |
Delete Public Holiday |
DELETE /api/v2/business/{businessId}/publicholiday/{id} |
Delete Public Holiday by Date |
DELETE /api/v2/business/{businessId}/publicholiday |
Get Public Holiday Details |
GET /api/v2/business/{businessId}/publicholiday/{id} |
Get Public Holidays for Year |
GET /api/v2/business/{businessId}/publicholiday |
Update Public Holiday |
PUT /api/v2/business/{businessId}/publicholiday/{id} |
Description | HTTP Request |
---|---|
Create Qualification |
POST /api/v2/business/{businessId}/qualification |
Delete Qualification |
DELETE /api/v2/business/{businessId}/qualification/{id} |
Get Qualification by ID |
GET /api/v2/business/{businessId}/qualification/{id} |
List Qualifications |
GET /api/v2/business/{businessId}/qualification |
Update Qualification |
PUT /api/v2/business/{businessId}/qualification/{id} |
Description | HTTP Request |
---|---|
Birthday Report |
GET /api/v2/business/{businessId}/report/birthday |
Costing Report |
GET /api/v2/business/{businessId}/report/costing |
Deductions Report |
GET /api/v2/business/{businessId}/report/deductions |
Detailed Activity Report |
GET /api/v2/business/{businessId}/report/detailedactivity |
Detailed Activity Report |
GET /api/v2/business/{businessId}/report/detailedactivity/xlsx |
Document Acknowledgements Report |
GET /api/v2/business/{businessId}/report/documentAcknowledgements |
Employee Audit Report |
GET /api/v2/business/{businessId}/report/employeeaudit |
Employee Details Report |
GET /api/v2/business/{businessId}/report/employeedetails |
Employee Details Report |
POST /api/v2/business/{businessId}/report/employeedetails |
Employee Details Report Fields |
GET /api/v2/business/{businessId}/report/employeedetails/fields |
Employee Payment History Report |
GET /api/v2/business/{businessId}/report/paymenthistory |
Get Pay Slips by Finalised Pay Run Id |
GET /api/v2/business/{businessId}/report/payslip |
Get shift swapping report by business id |
GET /api/v2/business/{businessId}/report/shiftswapping |
Get tasks by business id |
GET /api/v2/business/{businessId}/report/tasks |
Gross To Net Report |
GET /api/v2/business/{businessId}/report/grosstonet |
Gross To Net Report as Excel |
GET /api/v2/business/{businessId}/report/grosstonet/xlsx |
Journal Report |
GET /api/v2/business/{businessId}/report/journal |
Leave Balances Report |
GET /api/v2/business/{businessId}/report/leavebalances |
Leave Balances Report as Excel |
GET /api/v2/business/{businessId}/report/leavebalances/xlsx |
Leave History Report |
GET /api/v2/business/{businessId}/report/leavehistory |
Leave Liability Report |
GET /api/v2/business/{businessId}/report/leaveliability |
Leave Liability report as Excel |
GET /api/v2/business/{businessId}/report/leaveliability/xlsx |
Pay Categories Report |
GET /api/v2/business/{businessId}/report/paycategories |
Pay Run Audit Report |
GET /api/v2/business/{businessId}/report/payrunaudit/{payRunId}/xlxs |
Pay Run Inclusions Report |
GET /api/v2/business/{businessId}/report/payruninclusions |
Pay Run Variance Report |
GET /api/v2/business/{businessId}/report/payrunvariance/xlxs |
Prepare Leave Liability report |
POST /api/v2/business/{businessId}/report/leaveliability/preparation |
Roster vs Timesheet Comparison Report |
GET /api/v2/business/{businessId}/report/rostertimesheetcomparison |
Super Contribution Report as Excel |
GET /api/v2/business/{businessId}/report/supercontributions/xlsx |
Timesheet Report |
GET /api/v2/business/{businessId}/report/timesheet |
Description | HTTP Request |
---|---|
Get Reseller by ID |
GET /api/v2/reseller/{id} |
List Resellers |
GET /api/v2/reseller |
Description | HTTP Request |
---|---|
Create roster shift |
POST /api/v2/business/{businessId}/rostershift |
Find Matching Clock Off Roster Shift |
GET /api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockoff |
Find Matching Clock On Roster Shift |
GET /api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockon |
Find Nearby Roster Shifts |
GET /api/v2/business/{businessId}/rostershift/{employeeId}/nearby |
Get Roster Shifts |
GET /api/v2/business/{businessId}/rostershift |
Stub Shift Timesheets |
POST /api/v2/business/{businessId}/rostershift/{rosterShiftId}/stub |
Update roster shift |
PUT /api/v2/business/{businessId}/rostershift/{rosterShiftId} |
Description | HTTP Request |
---|---|
Create Tiered Leave Allowance Template |
POST /api/v2/business/{businessId}/tieredleaveallowancetemplate |
Delete Tiered Leave Allowance Template |
DELETE /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id} |
Get Tiered Leave Allowance Template by ID |
GET /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id} |
List Tiered Leave Allowance Templates |
GET /api/v2/business/{businessId}/tieredleaveallowancetemplate |
Update Tiered Leave Allowance Template |
PUT /api/v2/business/{businessId}/tieredleaveallowancetemplate/{id} |
Description | HTTP Request |
---|---|
Add Complete Shift for Employee |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/addshift |
Add Note to Shift |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes |
Add an Employee |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/staff |
Change PIN |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/changepin |
Check Employee |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkid |
Clock In Employee |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockon |
Clock Out Employee |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockoff |
Create Kiosk |
POST /api/v2/business/{businessId}/kiosk |
Delete Kiosk |
DELETE /api/v2/business/{businessId}/kiosk/{id} |
Delete Note from Shift |
DELETE /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId} |
Discard current shift |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/discard |
Employee Has Access |
GET /api/v2/business/{businessId}/kiosk/hasaccess/{employeeId} |
End Break |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/endbreak |
Get Employee Lookup Data |
GET /api/v2/business/{businessId}/kiosk/{kioskId}/lookupdata/{employeeId} |
Get Kiosk by ID |
GET /api/v2/business/{businessId}/kiosk/{id} |
Get Shift Notes |
GET /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes |
List Kiosk Staff |
GET /api/v2/business/{businessId}/kiosk/{kioskId}/staff |
List Kiosks |
GET /api/v2/business/{businessId}/kiosk |
Mark Shift Notes Read |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/read-state |
Send PIN Reset Email |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/emailreset |
Send PIN Reset SMS |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/smsreset |
Shifts |
POST /api/v2/business/{businessId}/kiosk/shifts |
Start Break |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/startbreak |
Update Kiosk |
PUT /api/v2/business/{businessId}/kiosk/{id} |
Verify Kiosk PIN |
POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkpin |
Description | HTTP Request |
---|---|
Bulk Insert Timesheets |
POST /api/v2/business/{businessId}/timesheet/bulk |
Create timesheet line |
POST /api/v2/business/{businessId}/timesheet |
Delete timesheet line |
DELETE /api/v2/business/{businessId}/timesheet/{timesheetLineId} |
Get Business Timesheets |
GET /api/v2/business/{businessId}/timesheet |
Update timesheet line |
PUT /api/v2/business/{businessId}/timesheet/{timesheetLineId} |
Update/Replace timesheets |
PUT /api/v2/business/{businessId}/timesheet/bulk |
Description | HTTP Request |
---|---|
Create Unavailability |
POST /api/v2/business/{businessId}/unavailability |
Delete Unavailability |
DELETE /api/v2/business/{businessId}/unavailability/{id} |
Get unavailability by ID |
GET /api/v2/business/{businessId}/unavailability/{id} |
List Unavailabilities |
GET /api/v2/business/{businessId}/unavailability |
Update Unavailability |
PUT /api/v2/business/{businessId}/unavailability/{id} |
Description | HTTP Request |
---|---|
Create New User |
POST /api/v2/user |
Get User Details |
GET /api/v2/user |
Update User |
PUT /api/v2/user |
Description | HTTP Request |
---|---|
Delete Web Hook Registration |
DELETE /api/v2/business/{businessId}/webhookregistrations/{id} |
Delete all Web Hook Registrations |
DELETE /api/v2/business/{businessId}/webhookregistrations |
Get Web Hook Registration by ID |
GET /api/v2/business/{businessId}/webhookregistrations/{id} |
List Web Hook Registrations |
GET /api/v2/business/{businessId}/webhookregistrations |
Register Web Hook |
POST /api/v2/business/{businessId}/webhookregistrations |
Test Web Hook |
GET /api/v2/business/{businessId}/webhookregistrations/{id}/test |
Update Web Hook Registration |
PUT /api/v2/business/{businessId}/webhookregistrations/{id} |
Description | HTTP Request |
---|---|
Active Employees Report |
GET /api/v2/whitelabel/{whiteLabelId}/reports/activeemployees |
Get White Label by ID |
GET /api/v2/whitelabel/{id} |
List White Labels |
GET /api/v2/whitelabel |
Signup Report |
GET /api/v2/whitelabel/{whitelabelId}/reports/signups |
Description | HTTP Request |
---|---|
Create Work Type |
POST /api/v2/business/{businessId}/worktype |
Delete Work Type |
DELETE /api/v2/business/{businessId}/worktype/{id} |
Get Work Type by ID |
GET /api/v2/business/{businessId}/worktype/{id} |
List Work Types |
GET /api/v2/business/{businessId}/worktype |
Update Work Type |
PUT /api/v2/business/{businessId}/worktype/{id} |