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
Authentication
Summary
OAuth Token
Single Sign On
Single Sign On
Single Sign On
Benefit Categories
Summary
Create benefit category
Delete benefit category
Get Benefit Category by ID
Get processing options
Get registered from tax year options
List Benefit Categories
Set processing options
Update Benefit Category
Brand
Summary
Active Employees Report
Cancel Business
Get Brand Label by ID
List Brand Labels
List Business Templates
Signup Report
Business
Summary
Assign Business Access
Change the tax year
Copy Business Settings From Template
Create BACS Settings Record
Create Business Document
Create Location
Create New Business
Create payslip configuration
Delete BACS Settings Record
Delete Business Document
Delete Location
Dismiss Business Notifications
Get All Statutory Maternity Leave Data
Get BACS Settings Record by ID
Get Business Billing Plans
Get Business Details
Get Business Details by External ID
Get Business Document Content
Get Business Document Details
Get Employee Portal Settings
Get Employment Allowance Settings
Get HMRC Settings
Get Location By Id
Get Rounding Rules
Get User Business Access
Get payslip configuration
Get the leave settings for the business
Get the timesheet settings for the business
List All Business Access Users
List BACS Settings
List Billing Plans
List Business Document Details
List Business Locations
List Business Notifications
List Businesses
List Employee Locations
List Entitlements
List the Business tags
Revoke Business Access
Set Business Billing Plan
Set Rounding Rules
Simple Update Employer HMRC Settings
Update BACS Settings Record
Update Business Details
Update Business Document Permissions
Update Employee Portal Settings
Update Employment Allowance Settings
Update HMRC Settings
Update Location
Update details of an associated user
Update the leave settings for the business
Update the timesheet settings for the business
Chart of Accounts
Summary
Bulk insert Journal Accounts
Create a new Journal Account
Delete Location Specific Chart of Accounts
Delete an existing Journal Account
Get Chart of Accounts
Get Journal Account Types
Get Journal Account by ID
Get Journal Accounts
Get Journal Service provider
Get Journal Service providers
Get Location Specific Chart of Accounts
Update Chart of Accounts
Update Journal Service provider
Update Location Specific Chart of Accounts
Update an existing Journal Account
Deduction Categories
Summary
Create Deduction Category
Delete Deduction Category
Get Deduction Category By ID
List Deduction Categories
Update Deduction Category
Dimensions
Summary
Create Dimension
Create Dimension Value
Delete Dimension
Delete Dimension Value
Get Dimension Value by ID
Get Dimension by ID
List Dimension Values
List Dimensions
Update Dimension
Update Dimension Value
Employee
Summary
Activate Employee
Apply National Insurance Back Calculation
Attach Employee Document to Statutory Adoption Leave
Attach Employee Document to Statutory Maternity Leave
Attach Employee Document to Statutory Parental Bereavement Leave
Attach Employee Document to Statutory Paternity Leave
Back calculate National Insurance
Calculate Statutory Adoption Leave Period Data
Calculate Statutory Maternity Leave Period Data
Calculate Statutory Parental Bereavement Leave Period Data
Calculate Statutory Paternity Leave Period Data
Create National Insurance Record and P45
Create Occupational Absence
Create Statutory Adoption Leave Period data
Create Statutory Maternity Leave Period data
Create Statutory Parental Bereavement Leave Period data
Create Statutory Paternity Leave Period data
Create Statutory Sick Pay
Create auto enrolment notice
Create or Update Employee
Delete Employee
Delete Employee Profile Image
Delete National Insurance Back Calculation
Delete Period of Leave
Delete Statutory Maternity Leave Data
Download Employee P11D form
Force Enrolment
Get Employee By External ID
Get Employee By External ID
Get Employee By External Reference ID
Get Employee By ID
Get Employee Notes
Get Employee Profile Image
Get Employee Shift Conditions
Get Employee Work Types
Get Employee basic details by ID
Get Leave Balances
Get National Insurance Back Calculation of employee
Get National Insurance Record and P45
Get Occupational Absence
Get Opening Balances
Get P45 model for employee
Get P60 model for employee
Get Pay Rates
Get Pension Contribution Plan
Get Statutory Adoption Leave Attachments
Get Statutory Maternity Leave Attachments
Get Statutory Maternity Leave Period Data
Get Statutory Maternity Leave Period Data By Id
Get Statutory Parental Bereavement Leave Attachments
Get Statutory Parental Bereavement Leave Period Data
Get Statutory Parental Bereavement Leave Period Data By ID
Get Statutory Paternity Leave Attachments
Get Statutory Paternity Leave Period Data
Get Statutory Paternity Leave Period Data By Id
Get Statutory Sick Pay By Employee
Get Statutory Sick Pay By Id
Get Year to date
Get standard hours for employee
Gets hmrc forms view model for employee
Grant Kiosk Access
List Employees
List basic details for employees
Notify employee by email of P60
Revoke Kiosk Access
Send P45-email to employee
Send auto-enrolment notification to employee
Set Employee Notes
Set Employee Profile Image
Set Opening Balances
Set standard hours for employee
Sync Employee to QBO
Unattach Employee Document from Statutory Adoption Leave
Unattach Employee Document from Statutory Maternity Leave
Unattach Employee Document from Statutory Parental Bereavement Leave
Unattach Employee Document from Statutory Paternity Leave
Update Employee
Update National Insurance Record and P45
Update Pension Contribution Plan
Employee Access
Summary
Get Employee Access for User
Get Users With Access to Employee
Grant Employee Access
Revoke Employee Access
Update Employee Access Record
Employee Bank Accounts
Summary
Create Bank Account
Delete Bank Account
Get Bank Account by ID
List Bank Accounts
Update Bank Account
Employee Benefit Categories
Summary
Create employee benefit
Get employee benefit
List employee benefits
Update employee benefit
Employee Documents
Summary
Create Employee Document
Delete Employee Document
Get Employee Document Content
Get Employee Document Details
Link Employee Document to Expense Request
Link Employee Document to Leave Request
Link Employee Document to Timesheet
List Employee Documents
Unlink Employee Document from Expense Request
Unlink Employee Document from Leave Request
Unlink Employee Document from Timesheet
Update Employee Document Permissions
Employee Earnings Line Split
Summary
Create Earnings line split
Delete Earnings line split
Get Earnings line split by location ID
Get Employee location earnings line splits
Update Earnings line split
Employee Expense Categories
Summary
Create Employee Expense Category
Delete Employee Expense Category
Get Employee Expense Category by ID
Get Tax Codes
List Employee Expense Categories
Update Employee Expense Category
Employee Expense Requests
Summary
Approve Expense Request
Create Expense Request
Decline Expense Request
Delete Expense Request
Get Expense Request by ID
List Expense Requests
Update Expense Request
Upload Attachment to Expense Request
Employee Groups
Summary
Create Employee Group
Delete Employee Group
Get Employee Group by ID
List Employee Groups
Update Employee Group
Employee Leave Allowances
Summary
Get Leave Allowances
Set Leave Allowances
Employee Onboarding
Summary
Initiate Employee Self Setup
Employee Pay Rate Schedule
Summary
Create pay rate adjustment schedule record
Delete pay rate adjustment schedule record
Get pay rate adjustment schedule record by ID
List pay rate adjustment schedule
Update pay rate adjustment schedule record
Employee Qualifications
Summary
Add/Update Employee Qualification
Create Employee Qualification Document
Delete Employee Qualification
Delete Employee Qualification Document
Get Qualification Details
Get Qualification Document File
Get Qualification Document by ID
Get Qualifications for Employee
List Documents for Employee Qualification
Employee Reporting Dimension Earnings Line Split
Summary
Create Dimension Earnings Line Split
Delete Dimension Earnings Line Split
Get Employee Dimension Earnings Line Split By Id
Get Employee Dimension Earnings Line Splits
Update Dimension Earnings Line Split
Employee Self Setup
Summary
Accept Roster Shift
Accept Shift Swap
Acknowledge Document
Add Employee Qualification
Add Note to Shift
Bulk Accept Roster Shift Swaps
Bulk Accept Roster Shifts
Bulk Cancel Roster Shift Swaps
Bulk Decline Roster Shift Swaps
Bulk Decline Roster Shifts
Cancel Shift Swap
Clock In Employee
Clock Out Employee
Create Bank Account
Create Expense Request
Create Leave Request
Create Unavailability
Decline Roster Shift
Decline Shift Swap
Delete Attachment from Leave Request
Delete Bank Account
Delete Employee Profile Image
Delete Employee Qualification
Delete Expense Request
Delete Leave Request
Delete Timesheet
Delete Unavailability
Delete attachment from EmployeeQualification
Discard current shift
Download Document
Edit Timesheet
Employees Eligible For Shift Swap
End Break
Estimate Leave Hours
Find Matching Clock Off Roster Shift
Find Matching Clock On Roster Shift
Find Nearby Roster Shifts
Get Bank Account by ID
Get Dashboard
Get Details
Get Document Details by ID
Get Emergency Contacts
Get Employee Profile Image
Get Employees
Get Enabled Features
Get Expense Categories
Get Expense Payment Summary
Get Expense Request by ID
Get Expense Requests
Get Leave Balances
Get Leave Categories
Get Leave Request by ID
Get Leaving employee form PDF
Get Locations
Get Lookup Data
Get P11D form PDF
Get P60 certificate PDF
Get P60 certificates
Get Pay Slip by Pay Run ID
Get Personal Details
Get Qualification Details
Get Qualifications for Employee
Get Roster Shift by ID
Get Satisfaction Survey Results
Get Shift Conditions
Get Shift Notes
Get Suburb
Get Tax Codes
Get Timesheet Creation Data
Get Titles
Get Work Types
Get public holidays
Get unavailability by ID
List Bank Accounts
List Leave Requests
List P11D forms
List Pay Slips
List Roster Shifts
List Timesheets
List Unavailabilities
List all Documents
Mark Shift Notes Read
Propose Shift Swap
Recover Forgotten Password
Register Device Token
Save Details
Save Emergency Contacts
Search Suburbs
Set Employee Profile Image
Shifts
Start Break
Submit Satisfaction Survey
Submit or Update Timesheet
Unregister Device Token
Update Bank Account
Update Emergency Contacts
Update Employee Qualification
Update Expense Request
Update Leave Request
Update Personal Details
Update Unavailability
Upload Attachment to Expense Request
Upload Attachment to Leave Request
Upload attachment to qualification
Employer Liability Categories
Summary
Create Employer Liability Category
Delete Employer Liability Category
Get Employer Liability Category
List Employer Liability Categories
Update Employer Liability Category
Employment Agreement
Summary
Get Shift Costings for Employee
Get Shift Periods for Employee
Invoices
Summary
Get Brand Invoice By ID
Get Brand Invoice Excel By ID
Get Brand Invoice PDF By ID
Get Brand Invoices
Get Business Invoice By ID
Get Business Invoice PDF By ID
Get Business Invoices
Get Reseller Invoice By ID
Get Reseller Invoice Excel By ID
Get Reseller Invoice PDF By ID
Get Reseller Invoices
Leave Allowances
Summary
Assign Leave Allowance Template
Create Leave Allowance Template
Delete Leave Allowance Template
Get Leave Allowance Template by ID
Get Leave Allowance Template for Employee
Get Leave Allowances for All Employees
Get Leave Allowances for Employee
List Leave Allowance Templates
Reapply Leave Allowance Template
Set Leave Allowances
Update Leave Allowance Template
Leave Categories
Summary
Create Leave Category
Delete Leave Category
Get Leave Category by ID
List Leave Categories
Save Leave Year Settings
Update Leave Category
Leave Requests
Summary
Approve Leave Request
Create Leave Request
Decline Leave Request
Delete Leave Request
Estimate Leave Units
Get Leave Request by ID
Get Leave Requests for Employee
List Leave Requests
Update Leave Request
Update Leave Request
Lookup Data
Summary
List Employee Group Permission Types
List Report Types
List Time Zone Types
List Time Zone Types
List countries
List gender options
List industry options
Manager
Summary
Add Note to Shift
Add an Employee
Approve Expense Request
Approve Leave Request
Approve Timesheet
Change PIN
Check Employee
Clock In Employee
Clock Out Employee
Create Leave Request
Create Unavailability
Create expense request
Create kiosk timesheet line
Create roster shift
Create timesheet line
Decline Expense Request
Decline Leave Request
Delete Employee Profile Image
Delete Expense Request
Delete Leave Request
Delete Note from Shift
Delete Timesheet
Delete Unavailability
Discard current shift
Download Document
Edit Expense Request
Edit Timesheet
End Break
Estimate Leave Hours
Find Matching Clock Off Roster Shift
Find Matching Clock On Roster Shift
Find Nearby Roster Shifts
Get Business Expense Requests
Get Business Timesheets
Get Business Timesheets
Get Dashboard
Get Employee Lookup Data
Get Employee Profile Image
Get Kiosk by ID
Get Kiosks
Get Leave Balances
Get Leave Request Attachment
Get Leave Request by ID
Get List of Employees
Get List of Locations
Get Roster Shift by ID
Get Roster Shifts
Get Rounding Rules
Get Shift Notes
Get expense request
Get expenses reference data
Get the list of roles available
Get timesheet
Get timesheet reference data
Initiate Employee Self Setup
List Businesses
List Employee Groups
List Employee Locations
List Employee Locations
List Expense Categories
List Expense Request Employees
List Expense Request Locations
List Kiosk Staff
List Leave Categories
List Leave Categories
List Leave Employees
List Leave Locations
List Leave Requests
List Manager Roster Employees
List Roster Employees
List Roster Locations
List Tax Codes
List Timesheet Employees
List Timesheet Locations
Manage Roster Data
Mark Shift Notes Read
Overlapping Leave Requests
Overlapping Leave Requests
Reject Timesheet
Send PIN Reset Email
Send PIN Reset SMS
Set Employee Profile Image
Set Rounding Rules
Shifts
Start Break
Stub Shift Timesheets
Update Leave Request
Update Unavailability
Update comments in a timesheet
Update kiosk timesheet line
Update roster shift
Update timesheet line
Upload Attachment to Expense Request
Verify Kiosk PIN
Pay Category
Summary
Create Pay Category
Delete Pay Category
Get Pay Category by ID
List Pay Categories
Update Pay Category
Pay Rate Templates
Summary
Create Pay Rate Template
Delete Pay Rate Template
Get Pay Rate Template by ID
List Pay Rate Templates
Update Pay Rate Template
Pay Run
Summary
Add Statutory Maternity Pay
Add Statutory Sick Pay
Apply statutory adoption payments to pay run
Bulk Apply Leave Requests
Create Deductions
Create Earnings Lines
Create Employee Expenses
Create Employer Liabilities
Create HMRC Adjustments
Create Note for Employee
Create PAYE Adjustments
Create Pay Run
Create Pay Run (Async)
Delete Deduction
Delete Earnings Line
Delete Employee Expense
Delete Employer Liability
Delete HMRC Adjustment
Delete Leave Accrual
Delete Note for Employee
Delete PAYE Adjustment
Delete Pay Run
Delete Pay Run Notation
Exclude employee from pay run
Finalise Pay Run
Get BACS File
Get Benefits
Get Creation Status
Get Deductions by Employee ID
Get Earnings Lines by Employee ID
Get Employee Expenses by Employee ID
Get Employer Liabilities by Employee ID
Get HMRC Adjustments by Employee ID
Get Journal Details
Get Leave Accruals
Get Leave Accruals for Employee
Get PAYE Adjustments by Employee ID
Get Pay Run
Get Pay Run Summary
Get Pay Run Totals by Employee ID
Get Pay Slip Data by Employee ID
Get Pay Slip File
Get Statutory Sick Pay By Employee Id
Get Statutory Sick Pay By Id
Get pay run payments
Get statutory adoption pay calculation for pay run
Include Employee
List Benefits
List Deductions
List Earnings Lines
List Employee Expenses
List Employer Liabilities
List HMRC Adjustments
List PAYE Adjustments
List Pay Run Totals
List Pay Run Totals for Employee
List Pay Run Warnings
List Pay Runs
List Pay Runs Summaries
List Pay Slip Data
Net to Gross
Recalculate
Remove Employee from Pay Run
Save Leave Accruals
Set Pay Run Notation
Set UI Unlock enabled
Start Approval Process
Terminate Employee in Pay Run
Unlock Pay Run
Pay Run Inclusions
Summary
Create Employee Additional Earning
Create Employee Deduction
Create Employee Expense
Create Employee Tax Adjustment
Create Employer liability
Create Or Update Employee HMRC Adjustment
Delete Employee Additional Earning
Delete Employee Deduction
Delete Employee Expense
Delete Employee Hmrc Adjustment
Delete Employee Tax Adjustment
Delete Employer liability
Get Employee Additional Earning by ID
Get Employee Deduction by External Reference Id
Get Employee Deduction by ID
Get Employee Expense by ID
Get Employee HMRC adjustment by External Reference Id
Get Employee Tax Adjustment by ID
Get Employer liability by ID
Get Hmrc Adjustment By Id
List Employee Additional Earnings
List Employee Deductions
List Employee Deductions By External Reference Id
List Employee Expenses
List Employee Tax Adjustments
List Employer liabilities
List Hmrc Adjustments
Update Employee Additional Earning
Update Employee Deduction
Update Employee Expense
Update Employee Tax Adjustment
Update Employer liability
Pay Schedules
Summary
Create Pay Schedule
Delete Pay Schedule
Get Next Pay Date
Get Pay Schedule Metadata
Get Pay Schedule by ID
List Next Pay Dates
List Pay Schedules
Update Pay Schedule
Pension Settings
Summary
Create Pension Scheme
Create Pension Scheme Contribution Plan
Delete Pension Scheme
Get Pension Scheme
Get Pension Scheme Contribution Plan
List Pension Scheme Contribution Plans
List Pension Schemes
Set Pension Scheme Dates
Update Pension Scheme
Update Pension Scheme Contribution Plan
Public Holiday
Summary
Add a public holiday
Delete Public Holiday
Delete Public Holiday by Date
Get Public Holiday Details
Get Public Holidays for Year
Update Public Holiday
Qualifications
Summary
Create Qualification
Delete Qualification
Get Qualification by ID
List Qualifications
Update Qualification
Reporting
Summary
Birthday Report
Deductions Report
Detailed Activity Report
Document Acknowledgements Report
Employee Audit Report
Employee Details Report
Employee Details Report
Employee Details Report Fields
Employee Payment History Report
Employer Payment Summary Report
Employer Payment Summary Report
Employer Payment Summary XML By Id
Employer Payment Summary XML Without Submission
Employer Payment Summary submission
Exb Xml Without Submission
Full Payment Summary XML
Full Payment Summary XML Without Submission
Get Apprenticeship Levy Summary Report
Get CIS Deductions Summary Report
Get Hmrc Payment File
Get NI Deductions Summary Report
Get P32 Opening Balances Adjustments
Get P32 Report
Get P46(Car) reports
Get Pay Slips by Finalised Pay Run Id
Get shift swapping report by business id
Get tasks by business id
Gross To Net Report
Ignore P46(Car) detail
Journal Report
Leave Balances Report
Leave History Report
Leave Liability Report
List P60 Data
Load P60 Data
Pay Categories Report
Pay Run Inclusions Report
Pension Contributions Report
Publish P11d
Publish P60
Roster vs Timesheet Comparison Report
Show P60 Status
Submit Exb Submission
Submit Full Payment Summary submission
Timesheet Report
Update P32 Opening Balances Adjustments
Update P32 Report
Reseller
Summary
Get Reseller by ID
List Resellers
Roster Shifts
Summary
Create roster shift
Find Matching Clock Off Roster Shift
Find Matching Clock On Roster Shift
Find Nearby Roster Shifts
Get Roster Shifts
Stub Shift Timesheets
Update roster shift
Subcontractor
Summary
Create subcontractor
Save subcontractor payment details
Time and Attendance
Summary
Add Complete Shift for Employee
Add Note to Shift
Add an Employee
Change PIN
Check Employee
Clock In Employee
Clock Out Employee
Create Kiosk
Delete Kiosk
Delete Note from Shift
Discard current shift
Employee Has Access
End Break
Get Employee Lookup Data
Get Kiosk by ID
Get Shift Notes
List Kiosk Staff
List Kiosks
Mark Shift Notes Read
Send PIN Reset Email
Send PIN Reset SMS
Shifts
Start Break
Update Kiosk
Verify Kiosk PIN
Timesheets
Summary
Bulk Insert Timesheets
Create timesheet line
Delete timesheet line
Get Business Timesheets
Update timesheet line
Update/Replace timesheets
Unavailability
Summary
Create Unavailability
Delete Unavailability
Get unavailability by ID
List Unavailabilities
Update Unavailability
User
Summary
Create New User
Get User Details
List Related Businesses And Employees, but just the IDs and their BrandIds and PartnerIds
List Related Businesses for the provided user.
List Related Partners
Update User
Webhook
Summary
Delete Web Hook Registration
Delete all Web Hook Registrations
Get Web Hook Registration by ID
List Web Hook Registrations
Register Web Hook
Test Web Hook
Update Web Hook Registration
White Label
Summary
Active Employees Report
Get White Label by ID
List White Labels
Signup Report
Work Types
Summary
Create Work Type
Delete Work Type
Get Work Type by ID
List Work Types
Update Work Type
OpenAPI specification
Download
PublishP11dRequestModel resource
Methods
post
- Publish P11d
Resource
{ "employeeId": "int32", "taxYear": "int32" }
Properties
Name
Type
Description
employeeId
int32
Int32
taxYear
int32
Int32