Available for the following plans: Employment Lite, Employment Plus
Available for the following Payroll plans: Standard, Premium, Core Payroll, Unlimited+Payroll
We have implemented our payroll API as a vanilla XML/JSON over HTTP and uses basic HTTP authentication. To use the API, you need to use your API Key, which you can find on the Account Details page.
Warning
This is valid for payroll subscribers only.
Helpful Hint
Each user intending to access the API should generate their own API Key. We base the access for a particular API Key on the access of the user who generates it. As a result, providing others with your API Key is essentially the same as providing your email/password to others.
Access my API key
- Log into your Employment Hero Payroll classic platform.
- Click the Account menu.
- Click the My Account submenu.
-
Click Security on the left-hand side menu.
Helpful Hint
You will find your Payroll classic platform API key in the API Key field.
Troubleshooting
Review integration status and logs
Check the integration dashboard for active/inactive status, recent errors, and timestamps. This helps you spot patterns and narrow down the cause.
Validate credentials
Ensure API keys or tokens are present, valid, and not expired. Guide the customer to re-enter or regenerate credentials if needed.
Check permissions and data mapping
Review user roles and access levels. Make sure the data being sent matches the API’s required format and fields.
Interpret error codes
Use error codes to guide your next steps. Each code points to a specific type of problem, such as permissions, formatting, or server issues.
Understanding API error codes helps you quickly diagnose API problems.
For example:
- 400 means a bad request (often a formatting issue).
- 401 is unauthorised (check credentials).
- 403 is forbidden (permissions issue).
- 404 means not found (wrong endpoint).
- 429 is too many requests (rate limit).
- 500 signals a server error (try again later).
Each error code points you to a specific troubleshooting step, saving time and confusion.
Further information
Are there any additional costs associated with using the API?
There are no additional costs associated with using the API.
Where can I find more information about the API?
For additional information on the API, please refer to our API Documentation.