| Description | HTTP Request |
|---|---|
| OAuth Token |
POST /oauth/token |
| Single Sign On |
POST /api/v2/business/{businessId}/employee/{employeeId}/singlesignon |
| Single Sign On |
POST /api/v2/singlesignon |
| Single Sign On |
POST /api/v2/business/{businessId}/singlesignon |
| Description | HTTP Request |
|---|---|
POST /api/v2/business/{businessId}/benefitcategory/multiple |
|
| Create benefit category |
POST /api/v2/business/{businessId}/benefitcategory |
| Delete benefit category |
DELETE /api/v2/business/{businessId}/benefitcategory/{id} |
| Get Benefit Category by ID |
GET /api/v2/business/{businessId}/benefitcategory/{id} |
| Get processing options |
GET /api/v2/business/{businessId}/benefitcategory/processingoptions |
| Get registered from tax year options |
GET /api/v2/business/{businessId}/benefitcategory/registeredfromtaxyearoptions |
| List Benefit Categories |
GET /api/v2/business/{businessId}/benefitcategory |
| Set processing options |
PUT /api/v2/business/{businessId}/benefitcategory/processingoptions |
| Update Benefit Category |
PUT /api/v2/business/{businessId}/benefitcategory |
| 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 |
|---|---|
DELETE /api/v2/business/{businessId}/hmrcsettings/hmrcpaymentreminder |
|
| 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 BACS Settings Record |
POST /api/v2/business/{businessId}/bacs |
| Create Business Document |
POST /api/v2/business/{businessId}/document |
| Create Location |
POST /api/v2/business/{businessId}/location |
| Create New Business |
POST /api/v2/business |
| Create payslip configuration |
POST /api/v2/business/{businessId}/payslip |
| Delete BACS Settings Record |
DELETE /api/v2/business/{businessId}/bacs/{id} |
| Delete Business Document |
DELETE /api/v2/business/{businessId}/document/{id} |
| Delete Location |
DELETE /api/v2/business/{businessId}/location/{id} |
| Dismiss Business Notifications |
DELETE /api/v2/business/{businessId}/actionitems/businessnotifications/{id}/dismiss |
| Get All Statutory Maternity Leave Data |
GET /api/v2/business/{businessId}/statutorypay |
| Get BACS Settings Record by ID |
GET /api/v2/business/{businessId}/bacs/{id} |
| Get Business Billing Plans |
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 Employment Allowance Settings |
GET /api/v2/business/{businessId}/hmrcsettings/employmentallowance |
| Get HMRC Settings |
GET /api/v2/business/{businessId}/hmrcsettings |
| Get Location By Id |
GET /api/v2/business/{businessId}/location/{id} |
| Get Rounding Rules |
GET /api/v2/business/{businessId}/roundingrules |
| Get User Business Access |
GET /api/v2/business/{businessId}/access/user |
| Get list of financial years |
GET /api/v2/business/{businessId}/taxyearlist |
| Get payslip configuration |
GET /api/v2/business/{businessId}/payslip |
| Get the leave settings for the business |
GET /api/v2/business/{businessId}/leavesettings |
| 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 BACS Settings |
GET /api/v2/business/{businessId}/bacs |
| List Billing Plans |
GET /api/v2/business/{businessId}/subscription/billingplans |
| List Business Document Details |
GET /api/v2/business/{businessId}/document |
| List Business Locations |
GET /api/v2/business/{businessId}/location |
| List Business Notifications |
GET /api/v2/business/{businessId}/actionitems/businessnotifications |
| List Businesses |
GET /api/v2/business |
| List Employee Locations |
GET /api/v2/business/{businessId}/employee/{employeeId}/location |
| List Entitlements |
GET /api/v2/business/{businessId}/entitlements |
| 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 |
| Simple Update Employer HMRC Settings |
PUT /api/v2/business/{businessId}/hmrcsettings/simple-update |
| Update BACS Settings Record |
PUT /api/v2/business/{businessId}/bacs/{id} |
| 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 Employment Allowance Settings |
PUT /api/v2/business/{businessId}/hmrcsettings/employmentallowance |
| Update HMRC Settings |
PUT /api/v2/business/{businessId}/hmrcsettings |
| Update Location |
PUT /api/v2/business/{businessId}/location/{id} |
| Update details of an associated user |
PUT /api/v2/business/{businessId}/access |
| Update the leave settings for the business |
PUT /api/v2/business/{businessId}/leavesettings |
| 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 |
|---|---|
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/downloadautoenrolmentnotice |
|
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45data |
|
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45download |
|
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60download/{financialYearEnding} |
|
| Activate Employee |
POST /api/v2/business/{businessId}/employee/activate/{employeeId} |
| Apply National Insurance Back Calculation |
POST /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation |
| Attach Employee Document to Statutory Adoption Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{id}/employeedocument/{documentId} |
| Attach Employee Document to Statutory Maternity Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{id}/employeedocument/{documentId} |
| Attach Employee Document to Statutory Neonatal Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{id}/employeedocument/{documentId} |
| Attach Employee Document to Statutory Parental Bereavement Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{id}/employeedocument/{documentId} |
| Attach Employee Document to Statutory Paternity Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{id}/employeedocument/{documentId} |
| Attach Employee Document to Statutory Shared Parental Leave |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{id}/employeedocument/{documentId} |
| Back calculate National Insurance |
GET /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation/calculation |
| Calculate Statutory Adoption Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sapcalc |
| Calculate Statutory Maternity Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smpcalc |
| Calculate Statutory Neonatal Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncpcalc |
| Calculate Statutory Parental Bereavement Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbpcalc |
| Calculate Statutory Paternity Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sppcalc |
| Calculate Statutory Shared Parental Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shppcalc |
| Create National Insurance Record and P45 |
POST /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord |
| Create Occupational Absence |
POST /api/v2/business/{businessId}/employee/{employeeId}/occupationalabsence |
| Create Statutory Adoption Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap |
| Create Statutory Maternity Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp |
| Create Statutory Neonatal Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp |
| Create Statutory Parental Bereavement Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp |
| Create Statutory Paternity Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp |
| Create Statutory Shared Parental Leave Period data |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp |
| Create Statutory Sick Pay |
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp |
| Create auto enrolment notice |
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/autoenrolmentnotice |
| 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 |
| Delete National Insurance Back Calculation |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation |
| Delete Period of Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} |
| Delete Statutory Maternity Leave Data |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{id} |
| Download Employee P11D form |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p11ddownload/{taxYear} |
| Force Enrolment |
POST /api/v2/business/{businessId}/employee/{employeeId}/pension/force |
| Get Employee By External ID |
GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId} |
| Get Employee By External ID |
GET /api/v2/business/{businessId}/employee |
| 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 National Insurance Back Calculation of employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation |
| Get National Insurance Record and P45 |
GET /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord |
| Get Occupational Absence |
GET /api/v2/business/{businessId}/employee/{employeeId}/occupationalabsence |
| Get Opening Balances |
GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances |
| Get P45 model for employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45 |
| Get P60 model for employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60/{financialYearEnding} |
| Get Pay Rates |
GET /api/v2/business/{businessId}/employee/{employeeId}/payrate |
| Get Pension Contribution Plan |
GET /api/v2/business/{businessId}/employee/{employeeId}/pension |
| Get Statutory Adoption Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{id}/attachments |
| Get Statutory Maternity Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{id}/attachments |
| Get Statutory Maternity Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp |
| Get Statutory Maternity Leave Period Data By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{id} |
| Get Statutory Neonatal Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{id}/attachments |
| Get Statutory Neonatal Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp |
| Get Statutory Neonatal Leave Period Data By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{id} |
| Get Statutory Parental Bereavement Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{id}/attachments |
| Get Statutory Parental Bereavement Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp |
| Get Statutory Parental Bereavement Leave Period Data By ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{id} |
| Get Statutory Paternity Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{id}/attachments |
| Get Statutory Paternity Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp |
| Get Statutory Paternity Leave Period Data By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{id} |
| Get Statutory Shared Parental Leave Attachments |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{id}/attachments |
| Get Statutory Shared Parental Leave Period Data |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp |
| Get Statutory Shared Parental Leave Period Data By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{id} |
| Get Statutory Sick Pay By Employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp |
| Get Statutory Sick Pay By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} |
| Get Year to date |
GET /api/v2/business/{businessId}/employee/{employeeId}/yeartodate |
| Get standard hours for employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/standardhours |
| Gets hmrc forms view model for employee |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms |
| 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 |
| Notify employee by email of P60 |
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60notify/{noticeId}/{financialYearEnding} |
| Revoke Kiosk Access |
POST /api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId} |
| Send P45-email to employee |
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/mailp45 |
| Send auto-enrolment notification to employee |
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/emailautoenrolmentnotice/{noticeId} |
| 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 |
| Sync Employee to QBO |
POST /api/v2/business/{businessId}/employee/{employeeId}/synctoqbo |
| Unattach Employee Document from Statutory Adoption Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{id}/employeedocument/{documentId} |
| Unattach Employee Document from Statutory Maternity Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{id}/employeedocument/{documentId} |
| Unattach Employee Document from Statutory Neonatal Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{id}/employeedocument/{documentId} |
| Unattach Employee Document from Statutory Parental Bereavement Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{id}/employeedocument/{documentId} |
| Unattach Employee Document from Statutory Paternity Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{id}/employeedocument/{documentId} |
| Unattach Employee Document from Statutory Shared Parental Leave |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{id}/employeedocument/{documentId} |
| Update Employee |
PUT /api/v2/business/{businessId}/employee/unstructured/{employeeId} |
| Update National Insurance Record and P45 |
PUT /api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord |
| Update Pension Contribution Plan |
PUT /api/v2/business/{businessId}/employee/{employeeId}/pension |
| Update Statutory Sick Pay |
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} |
| 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 benefit |
POST /api/v2/business/{businessId}/employee/{employeeId}/benefit |
| Get employee benefit |
GET /api/v2/business/{businessId}/employee/{employeeId}/benefit/{benefitCategoryId} |
| List employee benefits |
GET /api/v2/business/{businessId}/employee/{employeeId}/benefit |
| Update employee benefit |
PUT /api/v2/business/{businessId}/employee/{employeeId}/benefit |
| 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}/lookup/addresses/{suburbId} |
|
| 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 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 Leaving employee form PDF |
GET /api/v2/ess/{employeeId}/document/LeavingEmployeeForm |
| Get Locations |
GET /api/v2/ess/{employeeId}/lookup/location |
| Get Lookup Data |
GET /api/v2/ess/{employeeId}/timeandattendance/lookupdata |
| Get P11D form PDF |
GET /api/v2/ess/{employeeId}/document/p11d/{taxYear} |
| Get P60 certificate PDF |
GET /api/v2/ess/{employeeId}/document/P60/{documentId} |
| Get P60 certificates |
GET /api/v2/ess/{employeeId}/document/p60s |
| Get P60 certificates |
GET /api/v2/ess/{employeeId}/document/p60s/swagrequired2fa |
| 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 P11D forms |
GET /api/v2/ess/{employeeId}/document/p11ds |
| List P11D forms |
GET /api/v2/ess/{employeeId}/document/p11ds/swagrequired2fa |
| List Pay Slips |
GET /api/v2/ess/{employeeId}/document/payslip/swagrequired2fa |
| List Pay Slips |
GET /api/v2/ess/{employeeId}/document/payslip |
| 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} |
| Update Bank Account |
PUT /api/v2/ess/{employeeId}/bankaccounts/{id}/swagrequired2fa |
| 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 |
|---|---|
| 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 |
| Save Leave Year Settings |
PUT /api/v2/business/{businessId}/leavecategory/saveleaveyearsettings |
| 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/{leaveRequestId} |
| Update Leave Request |
PUT /api/v2/business/{businessId}/employee/{employeeId}/leaverequest |
| 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/business/{businessId}/lookupdata/timezones |
| List Time Zone Types |
GET /api/v2/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/leaverequest/categories |
| List Leave Categories |
GET /api/v2/business/{businessId}/manager/{employeeId}/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/leaverequest/overlapping |
| Overlapping Leave Requests |
GET /api/v2/business/{businessId}/manager/{employeeId}/leaverequest/{leaveRequestId}/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 |
|---|---|
GET /api/v2/business/{businessId}/payrun/{payRunId}/details |
|
| Add Statutory Maternity Pay |
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/smp/employee/{employeeId} |
| Add Statutory Sick Pay |
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId} |
| Apply statutory adoption payments to pay run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId} |
| 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 HMRC Adjustments |
POST /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments |
| Create Note for Employee |
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId} |
| Create PAYE Adjustments |
POST /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments |
| 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 HMRC Adjustment |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments |
| 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 PAYE Adjustment |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments |
| Delete Pay Run |
DELETE /api/v2/business/{businessId}/payrun/{payRunId} |
| Delete Pay Run Notation |
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation |
| Exclude employee from pay run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/exclude/{employeeId} |
| Finalise Pay Run |
POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise |
| Get BACS File |
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bacs/{bacsDetailsId} |
| Get Benefits |
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits/{employeeId} |
| 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 HMRC Adjustments by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments/{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 PAYE Adjustments by Employee ID |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{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 Statutory Sick Pay By Employee Id |
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId} |
| Get Statutory Sick Pay By Id |
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/{sspId} |
| Get pay run payments |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payments |
| Get statutory adoption pay calculation for pay run |
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId} |
| Include Employee |
POST /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId} |
| List Benefits |
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits |
| 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 HMRC Adjustments |
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments |
| List PAYE Adjustments |
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments |
| 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 Deduction |
POST /api/v2/business/{businessId}/employee/{employeeId}/deduction |
| Create Employee Expense |
POST /api/v2/business/{businessId}/employee/{employeeId}/expense |
| Create Employee Tax Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment |
| Create Employer liability |
POST /api/v2/business/{businessId}/employee/{employeeId}/employerliability |
| Create Or Update Employee HMRC Adjustment |
POST /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment |
| Delete Employee Additional Earning |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{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 Hmrc Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{id} |
| Delete Employee Tax Adjustment |
DELETE /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{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 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 HMRC adjustment by External Reference Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{externalReferenceId} |
| Get Employee Tax Adjustment by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id} |
| Get Employer liability by ID |
GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id} |
| Get Hmrc Adjustment By Id |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment/{id} |
| List Employee Additional Earnings |
GET /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings |
| 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 Tax Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment |
| List Employer liabilities |
GET /api/v2/business/{businessId}/employee/{employeeId}/employerliability |
| List Hmrc Adjustments |
GET /api/v2/business/{businessId}/employee/{employeeId}/hmrcadjustment |
| Update Employee Additional Earning |
PUT /api/v2/business/{businessId}/employee/{employeeId}/additional-earnings/{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 Tax Adjustment |
PUT /api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{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 |
|---|---|
| Create Pension Scheme |
POST /api/v2/business/{businessId}/pensionscheme |
| Create Pension Scheme Contribution Plan |
POST /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan |
| Delete Pension Scheme |
DELETE /api/v2/business/{businessId}/pensionscheme/{id} |
| Get Pension Scheme |
GET /api/v2/business/{businessId}/pensionscheme/{id} |
| Get Pension Scheme Contribution Plan |
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId} |
| List Pension Scheme Contribution Plans |
GET /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan |
| List Pension Schemes |
GET /api/v2/business/{businessId}/pensionscheme |
| Set Pension Scheme Dates |
POST /api/v2/business/{businessId}/pensionscheme/dates |
| Update Pension Scheme |
PUT /api/v2/business/{businessId}/pensionscheme/{id} |
| Update Pension Scheme Contribution Plan |
PUT /api/v2/business/{businessId}/pensionscheme/{schemeId}/plan/{planId} |
| 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 |
| 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 |
| Download P32 Report PDF |
GET /api/v2/business/{businessId}/report/p32/download/pdf |
| 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 |
| Employer Payment Summary Report |
GET /api/v2/business/{businessId}/report/eps |
| Employer Payment Summary Report |
GET /api/v2/business/{businessId}/report/eps/{id} |
| Employer Payment Summary XML By Id |
GET /api/v2/business/{businessId}/report/eps/{id}/xml |
| Employer Payment Summary XML Without Submission |
POST /api/v2/business/{businessId}/report/eps/epsxml |
| Employer Payment Summary submission |
POST /api/v2/business/{businessId}/report/eps |
| Exb Xml Without Submission |
POST /api/v2/business/{businessId}/report/p11d/xml |
| Full Payment Summary XML |
GET /api/v2/business/{businessId}/report/fps/xml/{transactionid} |
| Full Payment Summary XML Without Submission |
POST /api/v2/business/{businessId}/report/fps/fpsxml |
| Get Apprenticeship Levy Summary Report |
GET /api/v2/business/{businessId}/report/p32/apprenticeshiplevy |
| Get CIS Deductions Summary Report |
GET /api/v2/business/{businessId}/report/p32/cisdeductionssummary |
| Get Hmrc Payment File |
GET /api/v2/business/{businessId}/report/p32/hmrcpaymentfile |
| Get NI Deductions Summary Report |
GET /api/v2/business/{businessId}/report/p32/nideductionssummary |
| Get P32 Opening Balances Adjustments |
GET /api/v2/business/{businessId}/report/p32/openingbalancesadjustments |
| Get P32 Report data |
GET /api/v2/business/{businessId}/report/p32 |
| Get P46(Car) reports |
GET /api/v2/business/{businessId}/report/p46car |
| 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 |
| Ignore P46(Car) detail |
POST /api/v2/business/{businessId}/report/p46car/ignore |
| 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 |
| List P60 Data |
GET /api/v2/business/{businessId}/report/p60/list |
| Load P60 Data |
GET /api/v2/business/{businessId}/report/p60/{employeeId} |
| P45 PDF Report |
GET /api/v2/business/{businessId}/report/p45/pdf |
| P45 Report |
GET /api/v2/business/{businessId}/report/p45 |
| 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 |
| Pension Contributions Report data |
GET /api/v2/business/{businessId}/report/pensioncontributions |
| Pension Contributions Report excel file |
GET /api/v2/business/{businessId}/report/pensioncontributions/xlsx |
| Prepare Leave Liability report |
POST /api/v2/business/{businessId}/report/leaveliability/preparation |
| Publish P11d |
POST /api/v2/business/{businessId}/report/p11d/publish |
| Publish P60 |
POST /api/v2/business/{businessId}/report/p60/publish |
| Roster vs Timesheet Comparison Report |
GET /api/v2/business/{businessId}/report/rostertimesheetcomparison |
| Show P60 Status |
POST /api/v2/business/{businessId}/report/p60/ispublished |
| Submit Exb Submission |
POST /api/v2/business/{businessId}/report/p11d |
| Submit Full Payment Summary submission |
POST /api/v2/business/{businessId}/report/fps |
| Super Contribution Report as Excel |
GET /api/v2/business/{businessId}/report/supercontributions/xlsx |
| Timesheet Report |
GET /api/v2/business/{businessId}/report/timesheet |
| Update P32 Opening Balances Adjustments |
PUT /api/v2/business/{businessId}/report/p32/openingbalancesadjustments |
| Update P32 Report |
PUT /api/v2/business/{businessId}/report/p32 |
| 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 subcontractor |
POST /api/v2/business/{businessId}/subcontractor |
| Save subcontractor payment details |
POST /api/v2/business/{businessId}/subcontractor/{subcontractorId}/paymentdetails |
| 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} |