Authentication

Description HTTP Request
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
OAuth Token
POST /oauth/token

Business

Description HTTP Request
Get Location By Id
GET /api/v2/business/{businessId}/location/{id}
Update Location
PUT /api/v2/business/{businessId}/location/{id}
Delete Location
DELETE /api/v2/business/{businessId}/location/{id}
Get User Business Access
GET /api/v2/business/{businessId}/access/user
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}
Delete Location Specific Chart of Accounts
DELETE /api/v2/business/{businessId}/chartofaccounts/location/{locationId}
Update the QuickBooks RealmId on the business
POST /api/v2/business/{businessId}/quickbooksrealmid/{id}
Get HMRC Settings
GET /api/v2/business/{businessId}/hmrcsettings
Update HMRC Settings
PUT /api/v2/business/{businessId}/hmrcsettings
Get Business Document Content
GET /api/v2/business/{businessId}/document/{id}/content
Get ATO Details
GET /api/v2/business/{businessId}/ato
Set ATO Details
POST /api/v2/business/{businessId}/ato
List All Business Access Users
GET /api/v2/business/{businessId}/access
Assign Business Access
POST /api/v2/business/{businessId}/access
Update Business Access
PUT /api/v2/business/{businessId}/access
Revoke Business Access
DELETE /api/v2/business/{businessId}/access
List Business Document Details
GET /api/v2/business/{businessId}/document
Create Business Document
POST /api/v2/business/{businessId}/document
List Business Notifications
GET /api/v2/business/{businessId}/actionitems/businessnotifications
List Business Locations
GET /api/v2/business/{businessId}/location
Create Location
POST /api/v2/business/{businessId}/location
List Businesses
GET /api/v2/business
Create New Business
POST /api/v2/business
Update Business Details
PUT /api/v2/business
Get BACS Settings Record by ID
GET /api/v2/business/{businessId}/bacs/{id}
Update BACS Settings Record
PUT /api/v2/business/{businessId}/bacs/{id}
Delete BACS Settings Record
DELETE /api/v2/business/{businessId}/bacs/{id}
Get Business Document Details
GET /api/v2/business/{businessId}/document/{id}
Update Business Document Permissions
PUT /api/v2/business/{businessId}/document/{id}
Delete Business Document
DELETE /api/v2/business/{businessId}/document/{id}
List Employee Locations
GET /api/v2/business/{businessId}/employee/{employeeId}/location
List BACS Settings
GET /api/v2/business/{businessId}/bacs
Create BACS Settings Record
POST /api/v2/business/{businessId}/bacs
List Entitlements
GET /api/v2/business/{businessId}/entitlements
Dismiss Business Notifications
DELETE /api/v2/business/{businessId}/actionitems/businessnotifications/{id}/dismiss
Get Rounding Rules
GET /api/v2/business/{businessId}/roundingrules
Set Rounding Rules
POST /api/v2/business/{businessId}/roundingrules
Get Chart of Accounts
GET /api/v2/business/{businessId}/chartofaccounts
Update Chart of Accounts
POST /api/v2/business/{businessId}/chartofaccounts
Get Business Details by External ID
GET /api/v2/business/externalid
Get Business Details
GET /api/v2/business/{businessId}

Chart of Accounts

Description HTTP Request
Get Journal Account by ID
GET /api/v2/business/{businessId}/accounts/{id}
Update an existing Journal Account
PUT /api/v2/business/{businessId}/accounts/{id}
Delete an existing Journal Account
DELETE /api/v2/business/{businessId}/accounts/{id}
Get Journal Account Types
GET /api/v2/business/{businessId}/accounts/types
Bulk insert Journal Accounts
POST /api/v2/business/{businessId}/accounts/bulk
Get Journal Accounts
GET /api/v2/business/{businessId}/accounts
Create a new Journal Account
POST /api/v2/business/{businessId}/accounts
Get Journal Service providers
GET /api/v2/business/{businessId}/accounts/journalservices
Get Journal Service provider
GET /api/v2/business/{businessId}/accounts/journalservice
Update Journal Service provider
PUT /api/v2/business/{businessId}/accounts/journalservice

Deduction Categories

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

Employee

Description HTTP Request
Get P45 model for employee
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45
Get Statutory Maternity Leave Period Data
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp
Create Statutory Maternity Leave Period data
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp
Get Opening Balances
GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances
Set Opening Balances
POST /api/v2/business/{businessId}/employee/{employeeId}/openingbalances
Send auto-enrolment notification to employee
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/emailautoenrolmentnotice/{noticeId}
Revoke Kiosk Access
POST /api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId}
List Employees
GET /api/v2/business/{businessId}/employee/unstructured
Create or Update Employee
POST /api/v2/business/{businessId}/employee/unstructured
Activate Employee
POST /api/v2/business/{businessId}/employee/activate/{employeeId}
Get Employee By ID
GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}
Update Employee
PUT /api/v2/business/{businessId}/employee/unstructured/{employeeId}
Get Pay Rates
GET /api/v2/business/{businessId}/employee/{employeeId}/payrate
Get Employee basic details by ID
GET /api/v2/business/{businessId}/employee/{employeeId}/details
Get Employee Notes
GET /api/v2/business/{businessId}/employee/{employeeId}/notes
Set Employee Notes
POST /api/v2/business/{businessId}/employee/{employeeId}/notes
Grant Kiosk Access
POST /api/v2/business/{businessId}/employee/grantkioskaccess/{employeeId}
Get Employee By External Reference ID
GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source}
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
Send P45-email to employee
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/mailp45
Get Employee By External ID
GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}
Get Employee Work Types
GET /api/v2/business/{businessId}/employee/{employeeId}/worktype
Delete Employee
DELETE /api/v2/business/{businessId}/employee/{employeeId}
Get Employee Profile Image
GET /api/v2/business/{businessId}/employee/{employeeId}/image
Set Employee Profile Image
POST /api/v2/business/{businessId}/employee/{employeeId}/image
Delete Employee Profile Image
DELETE /api/v2/business/{businessId}/employee/{employeeId}/image
Get Pension Contribution Plan
GET /api/v2/business/{businessId}/employee/{employeeId}/pension
Update Pension Contribution Plan
PUT /api/v2/business/{businessId}/employee/{employeeId}/pension
Sync Employee to QBO
POST /api/v2/business/{businessId}/employee/{employeeId}/synctoqbo
Notify employee by email of P60
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60notify/{noticeId}/{financialYearEnding}
Get Employee By External ID
GET /api/v2/business/{businessId}/employee
Get National Insurance Record and P45
GET /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord
Create National Insurance Record and P45
POST /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord
Update National Insurance Record and P45
PUT /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord
Gets hmrc forms view model for employee
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms
Create auto enrolment notice
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/autoenrolmentnotice
Get Statutory Sick Pay By Employee
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp
Create Statutory Sick Pay
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp
Force Enrolment
POST /api/v2/business/{businessId}/employee/{employeeId}/pension/force
Get Employee Shift Conditions
GET /api/v2/business/{businessId}/employee/{employeeId}/shiftcondition
Get Leave Balances
GET /api/v2/business/{businessId}/employee/{employeeId}/leavebalances
List basic details for employees
GET /api/v2/business/{businessId}/employee/details

Employee Access

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
Update Employee Access Record
PUT /api/v2/business/{businessId}/employee/{employeeId}/access
Revoke Employee Access
DELETE /api/v2/business/{businessId}/employee/{employeeId}/access
Get Employee Access for User
GET /api/v2/business/{businessId}/employee/{employeeId}/access/email

Employee Bank Accounts

Description HTTP Request
Get Bank Account by ID
GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}
Delete Bank Account
DELETE /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}
Update Bank Account
PUT /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{id}
List Bank Accounts
GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount
Create Bank Account
POST /api/v2/business/{businessId}/employee/{employeeId}/bankaccount

Employee Documents

Description HTTP Request
Link Employee Document to Timesheet
POST /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/timesheet/{id}
Unlink Employee Document from Timesheet
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/timesheet/{id}
Get Employee Document Details
GET /api/v2/business/{businessId}/employee/{employeeId}/document/{id}
Delete Employee Document
DELETE /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}
Unlink Employee Document from Expense Request
DELETE /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}
Unlink Employee Document from Leave Request
DELETE /api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/leave/{id}
Get Employee Document Content
GET /api/v2/business/{businessId}/employee/{employeeId}/document/{id}/content
List Employee Documents
GET /api/v2/business/{businessId}/employee/{employeeId}/document
Create Employee Document
POST /api/v2/business/{businessId}/employee/{employeeId}/document
Update Employee Document Permissions
PUT /api/v2/business/{businessId}/employee/{employeeId}/document

Employee Expense Categories

Description HTTP Request
Get Employee Expense Category by ID
GET /api/v2/business/{businessId}/employeeexpensecategory/{id}
Update Employee Expense Category
PUT /api/v2/business/{businessId}/employeeexpensecategory/{id}
Delete Employee Expense Category
DELETE /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
Create Employee Expense Category
POST /api/v2/business/{businessId}/employeeexpensecategory

Employee Expense Requests

Description HTTP Request
Decline Expense Request
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/decline
List Expense Requests
GET /api/v2/business/{businessId}/employee/{employeeId}/expenserequest
Create Expense Request
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest
Upload Attachment to Expense Request
PUT /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/attachment
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}
Delete Expense Request
DELETE /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}
Approve Expense Request
POST /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/approve

Employee Groups

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

Employee Qualifications

Description HTTP Request
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}
Delete Employee Qualification Document
DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id}
List Documents for Employee Qualification
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document
Create Employee Qualification Document
POST /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document
Get Qualifications for Employee
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification
Add/Update Employee Qualification
POST /api/v2/business/{businessId}/employee/{employeeId}/qualification
Delete Employee Qualification
DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification
Get Qualification Details
GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}

Employee Self Service

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

Employee Super Funds

Description HTTP Request
Update Super Fund
PUT /api/v2/business/{businessId}/employee/{employeeId}/superfund/{id}
Get Super Fund by ID
GET /api/v2/business/{businessId}/employee/{employeeId}/superfund/{superFundId}
Delete Super Fund
DELETE /api/v2/business/{businessId}/employee/{employeeId}/superfund/{superfundId}
List Super Funds
GET /api/v2/business/{businessId}/employee/{employeeId}/superfund
Create Super Fund
POST /api/v2/business/{businessId}/employee/{employeeId}/superfund

Employer Liability Categories

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

Employment Agreement

Description HTTP Request
Get Shift Costings for Employee
POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftcosting
List Employment Agreements
GET /api/v2/business/{businessId}/employmentagreement
Get Employment Agreement by ID
GET /api/v2/business/{businessId}/employmentagreement/{id}
Get Shift Periods for Employee
POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods
Bulk Evaluate Shift Costings
POST /api/v2/business/{businessId}/employmentagreement/{id}/shiftcosting/bulk
Get Shift Periods
POST /api/v2/business/{businessId}/employmentagreement/{id}/shiftperiods
Evaluate Shift Costings
POST /api/v2/business/{businessId}/employmentagreement/{id}/shiftcosting

Invoices

Description HTTP Request
Get White Label Invoice By ID
GET /api/v2/whitelabel/{whiteLabelId}/Invoice/{id}
Get Business Invoices
GET /api/v2/business/{businessId}/Invoice
Get Reseller Invoices
GET /api/v2/reseller/{resellerId}/Invoice
Get White Label Invoices
GET /api/v2/whitelabel/{whiteLabelId}/Invoice
Get Reseller Invoice By ID
GET /api/v2/reseller/{resellerId}/Invoice/{id}
Get Business Invoice By ID
GET /api/v2/business/{businessId}/Invoice/{id}

Leave Allowances

Description HTTP Request
Get Leave Allowances for Employee
GET /api/v2/business/{businessId}/leaveallowances/{employeeId}
List Leave Allowance Templates
GET /api/v2/business/{businessId}/leaveallowancetemplate
Create Leave Allowance Template
POST /api/v2/business/{businessId}/leaveallowancetemplate
Get Leave Allowances for All Employees
GET /api/v2/business/{businessId}/leaveallowances
Set Leave Allowances
PUT /api/v2/business/{businessId}/leaveallowances
Get Leave Allowance Template by ID
GET /api/v2/business/{businessId}/leaveallowancetemplate/{id}
Update Leave Allowance Template
PUT /api/v2/business/{businessId}/leaveallowancetemplate/{id}
Delete Leave Allowance Template
DELETE /api/v2/business/{businessId}/leaveallowancetemplate/{id}

Leave Categories

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

Leave Requests

Description HTTP Request
List Leave Requests
GET /api/v2/business/{businessId}/leaverequest
Approve Leave Request
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve
Decline Leave Request
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline
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}
Update Leave Request
PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}
Delete Leave Request
DELETE /api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}
Get Leave Requests for Employee
GET /api/v2/business/{businessId}/employee/{employeeId}/leaverequest
Create Leave Request
POST /api/v2/business/{businessId}/employee/{employeeId}/leaverequest

Lookup Data

Description HTTP Request
List Time Zone Types
GET /api/v2/business/{businessId}/lookupdata/timezones
List Time Zone Types
GET /api/v2/lookupdata/timezones
List Report Types
GET /api/v2/lookupdata/reports
List Employee Group Permission Types
GET /api/v2/lookupdata/employeegrouppermissions

Manager

Description HTTP Request
Get Business Expense Requests
GET /api/v2/business/{businessId}/manager/expense
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}
Delete Leave Request
DELETE /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}
Clock In Employee
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockon
List Employee Locations
GET /api/v2/business/{businessId}/manager/location
Get expenses reference data
GET /api/v2/business/{businessId}/manager/{employeeId}/expense/reference
Get Business Timesheets
GET /api/v2/business/{businessId}/manager/timesheet
Create timesheet line
POST /api/v2/business/{businessId}/manager/timesheet
Download Document
GET /api/v2/business/{businessId}/manager/{employeeId}/document/download/{documentId}
Send PIN Reset Email
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/emailreset
Approve Timesheet
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/approve
Approve Expense Request
POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/approve
Decline Expense Request
POST /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/decline
Check Employee
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkid
List Leave Employees
GET /api/v2/business/{businessId}/manager/leaverequest/employees
Get Employee Lookup Data
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/lookupdata/{employeeId}
Reject Timesheet
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}/reject
Get Leave Balances
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/balances
Upload Attachment to Expense Request
PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}/attachment
Update Unavailability
PUT /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId}
Delete Unavailability
DELETE /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId}
End Break
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/endbreak
Change PIN
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/changepin
Get timesheet
GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}
Edit Timesheet
POST /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}
Delete Timesheet
DELETE /api/v2/business/{businessId}/manager/{employeeId}/timesheet/{timesheetId}
Stub Shift Timesheets
POST /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}/stub
Manage Roster Data
GET /api/v2/business/{businessId}/manager/rostershift/manage
Shifts
POST /api/v2/business/{businessId}/manager/kiosk/shifts
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
Delete Employee Profile Image
DELETE /api/v2/business/{businessId}/manager/employee/{employeeId}/image
Get List of Employees
GET /api/v2/business/{businessId}/manager/employees
Overlapping Leave Requests
GET /api/v2/business/{businessId}/manager/leaverequest/overlapping
Find Matching Clock Off Roster Shift
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockoff
Get expense request
GET /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}
Edit Expense Request
PUT /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}
Delete Expense Request
DELETE /api/v2/business/{businessId}/manager/{employeeId}/expense/{expenseRequestId}
Estimate Leave Hours
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/estimate
Send PIN Reset SMS
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/smsreset
List Expense Request Employees
GET /api/v2/business/{businessId}/manager/expense/employees
Update comments in a timesheet
PUT /api/v2/business/{businessId}/manager/kiosk/timesheetcomments/{timesheetLineId}
List Employee Locations
GET /api/v2/business/{businessId}/manager/employee/{employeeId}/location
Create Leave Request
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest
Get Shift Notes
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes
Add Note to Shift
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes
Decline Leave Request
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/decline
Delete Note from Shift
DELETE /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId}
Find Nearby Roster Shifts
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/nearby
Get Rounding Rules
GET /api/v2/business/{businessId}/manager/roundingrules
Set Rounding Rules
POST /api/v2/business/{businessId}/manager/roundingrules
Get List of Locations
GET /api/v2/business/{businessId}/manager/locations
Update kiosk timesheet line
PUT /api/v2/business/{businessId}/manager/kiosk/timesheet/{timesheetLineId}
Verify Kiosk PIN
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/checkpin
List Leave Locations
GET /api/v2/business/{businessId}/manager/leaverequest/locations
Get timesheet reference data
GET /api/v2/business/{businessId}/manager/{employeeId}/timesheet/reference
Start Break
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/startbreak
Get the list of roles available
GET /api/v2/business/{businessId}/manager/rostershift/roles
Find Matching Clock On Roster Shift
GET /api/v2/business/{businessId}/manager/rostershift/{employeeId}/matchingclockon
Approve Leave Request
POST /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/approve
List Tax Codes
GET /api/v2/business/{businessId}/manager/expense/taxcodes
List Manager Roster Employees
GET /api/v2/business/{businessId}/manager/rostershift/manageemployees
Create Unavailability
POST /api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability
List Roster Locations
GET /api/v2/business/{businessId}/manager/rostershift/locations
Get Kiosks
GET /api/v2/business/{businessId}/manager/kiosk
Create expense request
POST /api/v2/business/{businessId}/manager/{employeeId}/expense
Get Kiosk by ID
GET /api/v2/business/{businessId}/manager/kiosk/{id}
Overlapping Leave Requests
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/overlapping
List Roster Employees
GET /api/v2/business/{businessId}/manager/rostershift/employees
Get Roster Shift by ID
GET /api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}
List Employee Groups
GET /api/v2/business/{businessId}/manager/timesheet/employeegroups
List Timesheet Locations
GET /api/v2/business/{businessId}/manager/timesheet/locations
List Expense Categories
GET /api/v2/business/{businessId}/manager/expense/categories
Get Businesses
GET /api/v2/manager/security/businesses
Get Leave Request Attachment
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/attachment
Discard current shift
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/discard
Clock Out Employee
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockoff
List Leave Categories
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/categories
List Leave Requests
GET /api/v2/business/{businessId}/manager/leaverequest
List Kiosk Staff
GET /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff
Add an Employee
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/staff
Get Business Timesheets
GET /api/v2/business/{businessId}/manager/kiosk/timesheet
Create kiosk timesheet line
POST /api/v2/business/{businessId}/manager/kiosk/timesheet
List Timesheet Employees
GET /api/v2/business/{businessId}/manager/timesheet/employees
List Leave Categories
GET /api/v2/business/{businessId}/manager/leaverequest/categories
Mark Shift Notes Read
POST /api/v2/business/{businessId}/manager/kiosk/{kioskId}/shift/{shiftId}/notes/read-state
Get Roster Shifts
GET /api/v2/business/{businessId}/manager/rostershift
List Expense Request Locations
GET /api/v2/business/{businessId}/manager/expense/locations
Update timesheet line
PUT /api/v2/business/{businessId}/manager/timesheet/{timesheetLineId}

Pay Category

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

Pay Rate Templates

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

Pay Run

Description HTTP Request
List HMRC Adjustments
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
Create HMRC Adjustments
POST /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
Delete HMRC Adjustment
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments
List PAYE Adjustments
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Create PAYE Adjustments
POST /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Delete PAYE Adjustment
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments
Get PAYE Adjustments by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId}
Get Pay Slip File
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId}
Create Pay Run (Async)
POST /api/v2/business/{businessId}/payrun/async
Terminate Employee in Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/terminate
Get HMRC Adjustments by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments/{employeeId}
List Pay Run Totals for Employee
GET /api/v2/business/{businessId}/employee/{employeeId}/payruntotals
Get Pay Slip Data by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}
Get Employer Liabilities by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId}
List Earnings Lines
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Create Earnings Lines
POST /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Delete Earnings Line
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Get Pay Run Totals by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}
List Employer Liabilities
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Create Employer Liabilities
POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Delete Employer Liability
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities
Get Statutory Sick Pay By Id
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/{sspId}
Get Leave Accruals
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Save Leave Accruals
POST /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Delete Leave Accrual
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
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}
Get Leave Accruals for Employee
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId}
Unlock Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/unlock
Get Employee Expenses by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId}
Set UI Unlock enabled
POST /api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate
Get Super Adjustments by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments/{employeeId}
Finalise Pay Run
POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise
List Pay Runs
GET /api/v2/business/{businessId}/payrun
Create Pay Run
POST /api/v2/business/{businessId}/payrun
Get Creation Status
GET /api/v2/business/{businessId}/payrun/creationstatus/{jobId}
Get Statutory Sick Pay By Employee Id
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId}
Add Statutory Sick Pay
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId}
Set Pay Run Notation
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation
Delete Pay Run Notation
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation
Get Earnings Lines by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}
Recalculate
POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate
Get pay run payments
GET /api/v2/business/{businessId}/payrun/{payRunId}/payments
List Deductions
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions
Create Deductions
POST /api/v2/business/{businessId}/payrun/{payRunId}/deductions
Delete Deduction
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/deductions
List Employee Expenses
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Create Employee Expenses
POST /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Delete Employee Expense
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Get Deductions by Employee ID
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId}
List Super Adjustments
GET /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments
Create Super Adjustments
POST /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments
Delete Super Adjustment
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments
List Pay Run Totals
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals
Get BACS File
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bacs/{bacsDetailsId}
List Pay Slip Data
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips
Remove Employee from Pay Run
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId}
Get Pay Run
GET /api/v2/business/{businessId}/payrun/{payRunId}
Delete Pay Run
DELETE /api/v2/business/{businessId}/payrun/{payRunId}
Add Statutory Maternity Pay
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/smp/employee/{employeeId}
Get Journal Details
GET /api/v2/business/{businessId}/journal/{payRunId}

Pay Run Inclusions

Description HTTP Request
Get Hmrc Adjustment By Id
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{id}
Delete Employee Hmrc Adjustment
DELETE /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{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}
Delete Employer liability
DELETE /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{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}
Delete Employee Deduction
DELETE /api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}
List Employee Deductions
GET /api/v2/business/{businessId}/employee/{employeeId}/deduction
Create Employee Deduction
POST /api/v2/business/{businessId}/employee/{employeeId}/deduction
List Employee Expenses
GET /api/v2/business/{businessId}/employee/{employeeId}/expense
Create Employee Expense
POST /api/v2/business/{businessId}/employee/{employeeId}/expense
Get Employee HMRC adjustment by External Reference Id
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{externalReferenceId}
List Employer liabilities
GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability
Create Employer liability
POST /api/v2/business/{businessId}/employee/{employeeId}/employerliability
Get Employee Super Adjustment by ID
GET /api/v2/business/{businessId}/employee/{employeeId}/superadjustment/{id}
Update Employee Super Adjustment
PUT /api/v2/business/{businessId}/employee/{employeeId}/superadjustment/{id}
Delete Employee Super Adjustment
DELETE /api/v2/business/{businessId}/employee/{employeeId}/superadjustment/{id}
List Employee Tax Adjustments
GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment
Create Employee Tax Adjustment
POST /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment
List Employee Super Adjustments
GET /api/v2/business/{businessId}/employee/{employeeId}/superadjustment
Create Employee Super Adjustment
POST /api/v2/business/{businessId}/employee/{employeeId}/superadjustment
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}
Delete Employee Expense
DELETE /api/v2/business/{businessId}/employee/{employeeId}/expense/{id}
Get Employee Deduction by External Reference Id
GET /api/v2/business/{businessId}/employee/{employeeId}/deduction/{externalReferenceId}
Create Or Update Employee HMRC Adjustment
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment
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}
Delete Employee Tax Adjustment
DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}

Pay Schedules

Description HTTP Request
Get Pay Schedule by ID
GET /api/v2/business/{businessId}/payschedule/{id}
Update Pay Schedule
PUT /api/v2/business/{businessId}/payschedule/{id}
Delete Pay Schedule
DELETE /api/v2/business/{businessId}/payschedule/{id}
Get Pay Schedule Metadata
GET /api/v2/business/{businessId}/payschedule/metadata
List Pay Schedules
GET /api/v2/business/{businessId}/payschedule
Create Pay Schedule
POST /api/v2/business/{businessId}/payschedule

Payment Summaries

Description HTTP Request
List Payment Summaries
GET /api/v2/business/{businessId}/paymentsummary/{financialYearEnding}
Publish Payment Summaries
POST /api/v2/business/{businessId}/paymentsummary/{financialYearEnding}
Generate Payment Summaries
PUT /api/v2/business/{businessId}/paymentsummary/{financialYearEnding}
Unpublish Payment Summaries
DELETE /api/v2/business/{businessId}/paymentsummary/{financialYearEnding}

Pension Settings

Description HTTP Request
Set Pension Scheme Dates
POST /api/v2/business/{businessId}/pensionscheme/dates
List Pension Scheme Contribution Plans
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan
Create Pension Scheme Contribution Plan
POST /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan
Get Pension Scheme Contribution Plan
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId}
Update Pension Scheme Contribution Plan
PUT /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId}
Get Pension Scheme
GET /api/v2/business/{businessId}/pensionscheme/{id}
Update Pension Scheme
PUT /api/v2/business/{businessId}/pensionscheme/{id}
Delete Pension Scheme
DELETE /api/v2/business/{businessId}/pensionscheme/{id}
List Pension Schemes
GET /api/v2/business/{businessId}/pensionscheme
Create Pension Scheme
POST /api/v2/business/{businessId}/pensionscheme

Public Holiday

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

Qualifications

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

Reporting

Description HTTP Request
Deductions Report
GET /api/v2/business/{businessId}/report/deductions
Detailed Activity Report
GET /api/v2/business/{businessId}/report/detailedactivity
Gross To Net Report
GET /api/v2/business/{businessId}/report/grosstonet
Birthday Report
GET /api/v2/business/{businessId}/report/birthday
Journal Report
GET /api/v2/business/{businessId}/report/journal
Pension Contributions Report
GET /api/v2/business/{businessId}/report/pensioncontributions
Pay Run Inclusions Report
GET /api/v2/business/{businessId}/report/payruninclusions
Employer Payment Summary Report
GET /api/v2/business/{businessId}/report/eps
Employer Payment Summary submission
POST /api/v2/business/{businessId}/report/eps
Timesheet report
GET /api/v2/business/{businessId}/report/timesheet
Leave History Report
GET /api/v2/business/{businessId}/report/leavehistory
Employer Payment Summary XML
GET /api/v2/business/{businessId}/report/eps/{id}/xml
Leave Liability Report
GET /api/v2/business/{businessId}/report/leaveliability
Employer Payment Summary Report
GET /api/v2/business/{businessId}/report/eps/{id}
Employee Details Report
GET /api/v2/business/{businessId}/report/employeedetails
Submit Full Payment Summary submission
POST /api/v2/business/{businessId}/report/fps
Full Payment Summary XML
GET /api/v2/business/{businessId}/report/fps/xml/{transactionid}
Employee Payment History Report
GET /api/v2/business/{businessId}/report/paymenthistory
roster vs timesheet comparison report
GET /api/v2/business/{businessId}/report/rostertimesheetcomparison
Employee Details Report
GET /api/v2/business/{businessId}/report/employeedetails/fields
Leave Balances Report
GET /api/v2/business/{businessId}/report/leavebalances
Pay Categories Report
GET /api/v2/business/{businessId}/report/paycategories

Reseller

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

Roster Shifts

Description HTTP Request
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
Find Matching Clock Off Roster Shift
GET /api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockoff
Stub Shift Timesheets
POST /api/v2/business/{businessId}/rostershift/{rosterShiftId}/stub
Get Roster Shifts
GET /api/v2/business/{businessId}/rostershift

Time and Attendance

Description HTTP Request
Add Complete Shift for Employee
POST /api/v2/business/{businessId}/kiosk/{kioskId}/addshift
Start Break
POST /api/v2/business/{businessId}/kiosk/{kioskId}/startbreak
List Kiosk Staff
GET /api/v2/business/{businessId}/kiosk/{kioskId}/staff
Add an Employee
POST /api/v2/business/{businessId}/kiosk/{kioskId}/staff
Discard current shift
POST /api/v2/business/{businessId}/kiosk/{kioskId}/discard
Change PIN
POST /api/v2/business/{businessId}/kiosk/{kioskId}/changepin
List Kiosks
GET /api/v2/business/{businessId}/kiosk
Create Kiosk
POST /api/v2/business/{businessId}/kiosk
Get Kiosk by ID
GET /api/v2/business/{businessId}/kiosk/{id}
Update Kiosk
PUT /api/v2/business/{businessId}/kiosk/{id}
Delete Kiosk
DELETE /api/v2/business/{businessId}/kiosk/{id}
Get Shift Notes
GET /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes
Add Note to Shift
POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes
Send PIN Reset SMS
POST /api/v2/business/{businessId}/kiosk/{kioskId}/smsreset
Clock In Employee
POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockon
Verify Kiosk PIN
POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkpin
Shifts
POST /api/v2/business/{businessId}/kiosk/shifts
Delete Note from Shift
DELETE /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId}
Employee Has Access
GET /api/v2/business/{businessId}/kiosk/hasaccess/{employeeId}
Clock Out Employee
POST /api/v2/business/{businessId}/kiosk/{kioskId}/clockoff
Check Employee
POST /api/v2/business/{businessId}/kiosk/{kioskId}/checkid
Mark Shift Notes Read
POST /api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/read-state
Get Employee Lookup Data
GET /api/v2/business/{businessId}/kiosk/{kioskId}/lookupdata/{employeeId}
Send PIN Reset Email
POST /api/v2/business/{businessId}/kiosk/{kioskId}/emailreset
End Break
POST /api/v2/business/{businessId}/kiosk/{kioskId}/endbreak

Timesheets

Description HTTP Request
Update timesheet line
PUT /api/v2/business/{businessId}/timesheet/{timesheetLineId}
Delete timesheet line
DELETE /api/v2/business/{businessId}/timesheet/{timesheetLineId}
Bulk Insert Timesheets
POST /api/v2/business/{businessId}/timesheet/bulk
Update/Replace timesheets
PUT /api/v2/business/{businessId}/timesheet/bulk
Get Business Timesheets
GET /api/v2/business/{businessId}/timesheet
Create timesheet line
POST /api/v2/business/{businessId}/timesheet

Unavailability

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

User

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

Webhook

Description HTTP Request
Test Web Hook
GET /api/v2/business/{businessId}/webhookregistrations/{id}/test
Get Web Hook Registration by ID
GET /api/v2/business/{businessId}/webhookregistrations/{id}
Update Web Hook Registration
PUT /api/v2/business/{businessId}/webhookregistrations/{id}
Delete Web Hook Registration
DELETE /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
Delete all Web Hook Registrations
DELETE /api/v2/business/{businessId}/webhookregistrations

White Label

Description HTTP Request
Signup Report
GET /api/v2/whitelabel/{whitelabelId}/reports/signups
List White Labels
GET /api/v2/whitelabel
Active Employees Report
GET /api/v2/whitelabel/{whitelabelId}/reports/activeemployees
Get White Label by ID
GET /api/v2/whitelabel/{id}

Work Types

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