Employment Hero Payroll API Reference
Home
About the API
API Key Authentication
OAuth2 Authentication
OData Filtering
.NET Client
Using the API
iFrame navigation
SSO Requests
List Addresses
Summary
get
Get Kiosk by ID
Summary
delete
get
put
Employee Details Report
Summary
get
post
Get Reseller Invoice Excel By ID
Summary
get
List Leave Requests
Summary
get
Costing Report
Summary
get
Get Leave Requests for Employee
Summary
post
get
put
Single Sign On
Summary
post
Revoke Kiosk Access
Summary
post
Get KiwiSaver Enrollment Options
Summary
get
Manage Roster Data
Summary
get
Get Brand Invoices
Summary
get
Get tasks by business id
Summary
get
Set UI Unlock enabled
Summary
post
List Employee Groups
Summary
post
get
Find Matching Clock Off Roster Shift
Summary
get
Get Leave Request Attachment
Summary
get
Get the timesheet settings for the business
Summary
get
put
Get Expense Payment Summary
Summary
get
Get Employee Expense by ID
Summary
delete
get
put
Upload attachment to qualification
Summary
put
Get Earnings line split by location ID
Summary
delete
get
put
Overlapping Leave Requests
Summary
get
Roster vs Timesheet Comparison Report
Summary
get
Verify Kiosk PIN
Summary
post
Clock In Employee
Summary
post
Get Leave Accruals
Summary
delete
get
post
Get Leave Allowances for All Employees
Summary
get
put
List Expense Request Locations
Summary
get
Get Expense Categories
Summary
get
Get pay run payments
Summary
get
List Employees
Summary
post
get
List Expense Request Employees
Summary
get
Get Lookup Data
Summary
get
Get Employee Access for User
Summary
get
List Employee Expenses
Summary
post
delete
get
Get Earnings Certificate PDF
Summary
get
Get Journal Service providers
Summary
get
List Employer liabilities
Summary
post
get
Start Payment Approval Process
Summary
get
List Expense Requests
Summary
post
get
Get Qualifications for Employee
Summary
post
get
Get Leave Request by ID
Summary
delete
get
put
Send PIN Reset SMS
Summary
post
Get Bank Account by ID
Summary
delete
get
put
Get Pay Schedule by ID
Summary
delete
get
put
Get White Label by ID
Summary
get
Update kiosk timesheet line
Summary
put
Get Employee Dimension Earnings Line Splits
Summary
post
get
put
List Pay Run Totals for Employee
Summary
get
Get Employee Group by ID
Summary
delete
get
put
Clone Pay Condition Rule Set
Summary
post
Send PIN Reset Email
Summary
post
Employees Eligible For Shift Swap
Summary
get
Get Employee Additional Earning by ID
Summary
delete
get
put
List Employee Tax Adjustments
Summary
post
get
List Employee Group Permission Types
Summary
get
List Unavailabilities
Summary
post
get
Get Employee Lookup Data
Summary
get
List Leave Requests
Summary
post
get
List Next Pay Dates
Summary
get
List Timesheets
Summary
get
post
Get Emergency Contacts
Summary
get
post
put
Decline Leave Request
Summary
post
Unregister Device Token
Summary
post
Start Approval Process
Summary
post
Decline Expense Request
Summary
post
Reapply Leave Allowance Template
Summary
post
Active Employees Report
Summary
get
Get expense request
Summary
delete
put
get
Timesheet Report
Summary
get
Search Suburbs
Summary
get
Get Pay Run Summary
Summary
get
Get Dimension by ID
Summary
delete
get
put
List Web Hook Registrations
Summary
delete
get
post
Mark Shift Notes Read
Summary
post
Find Nearby Roster Shifts
Summary
get
Get KiwiSaver Adjustments by Employee ID
Summary
get
Get Qualification Document by ID
Summary
delete
get
Upload Attachment to Leave Request
Summary
delete
put
Gross To Net Report as Excel
Summary
get
Bulk Insert Timesheets
Summary
post
put
Grant Kiosk Access
Summary
post
Add Complete Shift for Employee
Summary
post
List Tax Codes
Summary
get
Send PIN Reset SMS
Summary
post
Get Deductions by Employee ID
Summary
get
Get Reseller Invoices
Summary
get
List Pay Run Warnings
Summary
get
Find Matching Clock Off Roster Shift
Summary
get
List Documents for Employee Qualification
Summary
post
get
Get Business Document Content
Summary
get
Change PIN
Summary
post
Get PAYE Adjustments by Employee ID
Summary
get
Get Work Types
Summary
get
Create Unavailability
Summary
post
Get List of Employees
Summary
get
Get Business Timesheets
Summary
post
get
Get KiwiSaver options for employee
Summary
get
Get the initial tax year
Summary
post
get
Get Employees
Summary
get
Get Business Expense Requests
Summary
get
Mark Shift Notes Read
Summary
post
Acknowledge Document
Summary
post
Get Shift Notes
Summary
post
get
List Employer Liability Categories
Summary
post
get
List Business Locations
Summary
post
get
Set Pay Run Notation
Summary
delete
post
Single Sign On
Summary
post
List KiwiSaver Adjustments
Summary
post
delete
get
Get Bank Payment File
Summary
get
Get Pay Condition Rule Set by ID
Summary
get
put
Initiate Employee Self Setup
Summary
post
Link Employee Document to Timesheet
Summary
post
delete
Get Roster Shift by ID
Summary
get
Get Employing Entity Specific Chart of Accounts
Summary
delete
get
post
Get Holiday Leave Settings
Summary
get
put
Activate Employee
Summary
post
Get Leave Balances
Summary
get
Clock In Employee
Summary
post
List Time Zone Types
Summary
get
List Deductions
Summary
post
delete
get
Get Pay Slips by Finalised Pay Run Id
Summary
get
Download Document
Summary
get
List Businesses
Summary
post
get
List Employee Deductions By External Reference Id
Summary
post
List countries
Summary
get
Get Employee Profile Image
Summary
delete
get
post
Get Journal Service provider
Summary
get
put
Pay Run Inclusions Report
Summary
get
Employee Has Access
Summary
get
List Unavailabilities
Summary
post
get
Get Business Invoices
Summary
get
Get Employee Lookup Data
Summary
get
Deductions Report
Summary
get
Get Employee Expense Category by ID
Summary
delete
get
put
Get Bank Account by ID
Summary
delete
get
List Kiosks
Summary
post
get
Get Employee Deduction by External Reference Id
Summary
get
List Employee Expense Categories
Summary
post
get
Cancel Shift Swap
Summary
post
Pay Categories Report
Summary
get
Find Matching Clock Off Roster Shift
Summary
get
Mark Shift Notes Read
Summary
post
Ordinary Time Earnings Report
Summary
get
Estimate Leave Hours
Summary
get
Get Employer Liability Category
Summary
delete
get
put
Create a new direct billing user
Summary
post
Get Pay Schedule Metadata
Summary
get
Get Brand Label by ID
Summary
get
Get Locations
Summary
get
Bulk Decline Roster Shift Swaps
Summary
post
Get Timesheet Creation Data
Summary
get
Check Employee
Summary
post
Get Employee By External Reference ID
Summary
get
Get Leave Balances
Summary
get
Get Dimension Value by ID
Summary
delete
get
put
Update comments in a timesheet
Summary
put
Create Note for Employee
Summary
post
delete
Employee Details Report Fields
Summary
get
Get Employer liability by ID
Summary
delete
get
put
Send PIN Reset Email
Summary
post
Get Earnings Lines by Employee ID
Summary
get
Get User Business Access
Summary
get
Assign Leave Allowance Template
Summary
post
List Pay Slip Data
Summary
get
List PAYE Adjustments
Summary
post
delete
get
Get Pay Run Details
Summary
get
Get payslip configuration
Summary
post
get
Get Roster Shifts
Summary
post
get
Get Location By Id
Summary
delete
get
put
Get Employee Profile Image
Summary
delete
get
post
Get Chart of Accounts
Summary
get
post
Leave Liability Report
Summary
get
Export journals for a pay run using the ExportPayRunJournalCommand
Summary
post
Shifts
Summary
post
Get Opening Balances
Summary
get
post
List Work Types
Summary
post
get
Get Leave Accruals for Employee
Summary
get
Start Break
Summary
post
Get Employee location earnings line splits
Summary
post
get
Get Kiosk by ID
Summary
get
List Employing Entities
Summary
post
get
Get Employee Shift Conditions
Summary
get
Get Work Type by ID
Summary
delete
get
put
Bulk Apply Leave Requests
Summary
post
Get standard hours for employee
Summary
get
put
Get timesheet reference data
Summary
get
Change PIN
Summary
post
Journal Report
Summary
get
Get Public Holidays for Year
Summary
post
delete
get
Get Business Billing Plan
Summary
get
List Pay Run Totals
Summary
get
Get unavailability by ID
Summary
delete
get
put
Get Leave Request by ID
Summary
delete
get
post
Get Reseller Invoice By ID
Summary
get
Get Pay Run
Summary
delete
get
Get Journal Account Types
Summary
get
Get Employing Entity By ID
Summary
delete
get
put
Accept Roster Shift
Summary
post
List Bank Accounts
Summary
post
get
Leave Balances Report as Excel
Summary
get
Get Titles
Summary
get
Get Journal Account by ID
Summary
delete
get
put
Bulk Accept Roster Shifts
Summary
post
PAYE Report
Summary
get
Detailed Activity Report as Excel
Summary
get
Get Brand Invoice Excel By ID
Summary
get
Leave Balances Report
Summary
get
List Business Notifications
Summary
get
Employee Payment History Report
Summary
get
List Employee Locations
Summary
get
Get Satisfaction Survey Results
Summary
get
post
Get Kiosks
Summary
get
Get business advanced settings
Summary
get
put
Get Qualification Details
Summary
delete
get
put
Check Employee
Summary
post
Get Employee Document Details
Summary
delete
get
Create Pay Run (Async)
Summary
post
Get Employee By External ID
Summary
get
Get Pay Slip Data by Employee ID
Summary
get
List Employee Groups
Summary
get
Get Pay Slip File
Summary
get
Decline Roster Shift
Summary
post
Get Location Specific Chart of Accounts
Summary
delete
get
post
Cancel Business
Summary
delete
Get Dashboard
Summary
get
Recalculate
Summary
post
List Brand Labels
Summary
get
List Businesses
Summary
get
Get Earnings Certificates
Summary
get
Find Matching Clock On Roster Shift
Summary
get
Edit Timesheet
Summary
delete
post
Delete attachment from EmployeeQualification
Summary
delete
Get Leave Allowances for Employee
Summary
get
Get Suburb
Summary
get
List Time Zone Types
Summary
get
Detailed Activity Report
Summary
get
Update roster shift
Summary
put
List Leave Allowance Templates
Summary
post
get
Shifts
Summary
post
Get Document Details by ID
Summary
get
Clock Out Employee
Summary
post
Find Nearby Roster Shifts
Summary
get
Include Employee
Summary
post
delete
Create Leave Request
Summary
post
List Leave Employees
Summary
get
List Employee Deductions
Summary
post
get
Get List of Locations
Summary
get
Get Employee Profile Image
Summary
delete
get
post
Start Break
Summary
post
Get Web Hook Registration by ID
Summary
delete
get
put
Verify Kiosk PIN
Summary
post
Bulk Decline Roster Shifts
Summary
post
Get Dashboard
Summary
get
List Leave Locations
Summary
get
Initiate Employee Self Setup
Summary
post
End Break
Summary
post
Get Expense Requests
Summary
post
get
Get Pay Rates
Summary
get
Approve Expense Request
Summary
post
Get Employee Deduction by ID
Summary
delete
get
put
List Roster Locations
Summary
get
Get Expense Request by ID
Summary
delete
get
put
List Employer Liabilities
Summary
post
delete
get
List Kiosk Staff
Summary
post
get
Prepare Leave Liability report
Summary
post
Discard current shift
Summary
post
Get Expense Request by ID
Summary
delete
get
put
Get Business Details by External ID
Summary
get
Get Leave Allowance Template by ID
Summary
delete
get
put
Get Shift Notes
Summary
post
get
List Billing Plans
Summary
get
Dismiss Business Notifications
Summary
delete
Get Leave Allowances
Summary
get
put
Get Shift Costings for Employee
Summary
post
Bulk Accept Roster Shift Swaps
Summary
post
List Kiosk Staff
Summary
post
get
List Pay Slips
Summary
get
Terminate Employee in Pay Run
Summary
post
OAuth Token
Summary
post
List Business Templates
Summary
get
List Timesheet Employees
Summary
get
Get Employee By ID
Summary
get
put
Get Employee Expenses by Employee ID
Summary
get
Get shift swapping report by business id
Summary
get
List Pay Runs Summaries
Summary
get
Gross To Net Report
Summary
get
List gender options
Summary
get
Get Qualification Document File
Summary
get
Document Acknowledgements Report
Summary
get
Find Matching Clock On Roster Shift
Summary
get
Get Employee Portal Settings
Summary
get
post
Get Shift Periods for Employee
Summary
post
Get Employee basic details by ID
Summary
get
Finalise Pay Run
Summary
post
Stub Shift Timesheets
Summary
post
Get Deduction Category By ID
Summary
delete
get
put
Clock Out Employee
Summary
post
Single Sign On
Summary
post
Get pay rate adjustment schedule record by ID
Summary
delete
get
put
List basic details for employees
Summary
get
Get Leave Allowance Template for Employee
Summary
get
Estimate Leave Units
Summary
get
Get Rounding Rules
Summary
get
post
List Roster Employees
Summary
get
Get Qualification Details
Summary
get
Birthday Report
Summary
get
Clock In Employee
Summary
post
List Entitlements
Summary
get
Get Journal Accounts
Summary
post
get
Get the list of roles available
Summary
get
Get Business Invoice PDF By ID
Summary
get
List pay rate adjustment schedule
Summary
post
get
Get Leave Category by ID
Summary
delete
get
put
Discard current shift
Summary
post
Get Leave Balances
Summary
get
List Expense Categories
Summary
get
Get Creation Status
Summary
get
Delete Employee
Summary
delete
Delete Note from Shift
Summary
delete
Upload Attachment to Expense Request
Summary
put
List Leave Categories
Summary
get
Reject Timesheet
Summary
post
Get timesheet
Summary
delete
post
get
List Deduction Categories
Summary
post
get
Net to Gross
Summary
post
List Qualifications
Summary
post
get
Pay Run Variance Report
Summary
get
Get Details
Summary
get
post
Get Payment Files by Finalised Pay Run Id
Summary
get
End Break
Summary
post
Pay Run Audit Report
Summary
get
List Employee Additional Earnings
Summary
post
get
Approve Expense Request
Summary
post
List Earnings Lines
Summary
post
delete
get
List all Documents
Summary
get
List the Business tags
Summary
get
Get Pay Category by ID
Summary
delete
get
put
List Pay Schedules
Summary
post
get
Active Employees Report
Summary
get
Recalculate background job
Summary
post
Update Bank Account
Summary
put
Get Shift Notes
Summary
post
get
List Resellers
Summary
get
Upload Attachment to Expense Request
Summary
put
Upload Attachment to Expense Request
Summary
put
Bulk insert Journal Accounts
Summary
post
List Leave Categories
Summary
post
get
Get Reseller Invoice PDF By ID
Summary
get
Find Nearby Roster Shifts
Summary
get
Set Business Billing Plan
Summary
post
Start Break
Summary
post
KiwiSaver Report as Excel
Summary
get
Get Pay Slip by Pay Run ID
Summary
get
Approve Timesheet
Summary
post
List Employee Expenses
Summary
post
get
Get Employee Tax Adjustment by ID
Summary
delete
get
put
Clock Out Employee
Summary
post
Get Employee Document Content
Summary
get
Get Pay Run Totals by Employee ID
Summary
get
Get Roster Shift by ID
Summary
get
put
List Leave Categories
Summary
get
List Employee Documents
Summary
post
get
put
Get Employee Work Types
Summary
get
Get Tax Codes
Summary
get
Get expenses reference data
Summary
get
Update timesheet line
Summary
put
Test Web Hook
Summary
get
List Roster Shifts
Summary
get
List Employee Locations
Summary
get
List Dimensions
Summary
post
get
Get Employer Liabilities by Employee ID
Summary
get
List White Labels
Summary
get
Unlock Pay Run
Summary
post
Get Business Timesheets
Summary
post
get
List Pay Condition Rule Sets
Summary
post
get
Get Personal Details
Summary
get
put
Stub Shift Timesheets
Summary
post
List Leave Requests
Summary
get
List Report Types
Summary
get
Get User Details
Summary
post
get
put
List Employee Expense Categories with pagination
Summary
get
End Break
Summary
post
Get Journal Details
Summary
get
Get Rounding Rules
Summary
get
post
Get Public Holiday Details
Summary
delete
get
put
Get Employee Dimension Earnings Line Split By Id
Summary
delete
get
Register Device Token
Summary
post
Link Employee Document to Leave Request
Summary
post
delete
Get Roster Shifts
Summary
post
get
Overlapping Leave Requests
Summary
get
Get Shift Conditions
Summary
get
List Dimension Values
Summary
post
get
List industry options
Summary
get
Get Qualification by ID
Summary
delete
get
put
Get Qualifications for Employee
Summary
post
delete
get
Shifts
Summary
post
Recover Forgotten Password
Summary
post
Delete Note from Shift
Summary
delete
Get Brand Invoice By ID
Summary
get
Get Business Timesheets
Summary
post
get
Estimate Leave Hours
Summary
get
Get Enabled Features
Summary
get
Update Unavailability
Summary
delete
put
Get Brand Invoice PDF By ID
Summary
get
Employee Audit Report
Summary
get
Get unavailability by ID
Summary
delete
get
put
Decline Shift Swap
Summary
post
Decline Leave Request
Summary
post
KiwiSaver Report
Summary
get
Get public holidays
Summary
get
Approve Leave Request
Summary
post
List All Business Access Users
Summary
post
get
delete
put
List Timesheet Locations
Summary
get
Accept Shift Swap
Summary
post
Get Leave Request by ID
Summary
delete
get
post
Get Users With Access to Employee
Summary
get
post
delete
put
Get Business Details
Summary
get
List Employee Locations
Summary
get
Get Employee Notes
Summary
get
post
List Business Document Details
Summary
post
get
List Pay Runs
Summary
post
get
Employee Payment History Report as Excel
Summary
get
Bulk Cancel Roster Shift Swaps
Summary
post
Create expense request
Summary
post
Copy Business Settings From Template
Summary
post
List Pay Rate Templates
Summary
post
get
Get Pay Rate Template by ID
Summary
delete
get
put
List Bank Accounts
Summary
post
get
Signup Report
Summary
get
Get Tax Codes
Summary
get
List Pay Categories
Summary
post
get
Decline Expense Request
Summary
post
Get Business Document Details
Summary
delete
get
put
Get Business Invoice By ID
Summary
get
Leave Liability report as Excel
Summary
get
Signup Report
Summary
get
Get Leave Categories
Summary
get
Get timesheet line
Summary
delete
get
put
Link Employee Document to Expense Request
Summary
post
delete
Get Next Pay Date
Summary
get
Find Matching Clock On Roster Shift
Summary
get
List Manager Roster Employees
Summary
get
Get Reseller by ID
Summary
get
Discard current shift
Summary
post
Download Document
Summary
get
Propose Shift Swap
Summary
post
Approve Leave Request
Summary
post
OpenAPI specification
Download
Get KiwiSaver Enrollment Options
Description
HTTP Request
Get KiwiSaver Enrollment Options
GET /api/v2/ess/{employeeId}/lookup/enrollmentoptions