- Create Xero Account and ensure country selection is New Zealand.
- Open the tab Payroll > Overview (mandatory to open for Xero to activate payroll integration in the background)
- Ensure the correct Organisation is selected if there are multiple and then open settings. (Organisation must be active)
- Open Users
- Select “Invite a user” from the top right
- Enter the first name, last name and email.
The invited email will be the master login for the Xero and Humanforce Integration, this account will be the only way for Humanforce Consultants to lookup the meaning of error codes provided by Xero during payroll processing or employee integration should there be any issues.
As such please ensure the invited user’s credentials are shared with Humanforce so the credentials can be securely documented for future use.
- Email + password (E.g., Outlook or Gmail credentials)
- Email + password + 2fA setup key for Xero login (sign up required, follow prompts from invite)
Alternatively, a Humanforce provided email can be used, replace ‘example’ with your company name: xerosetup+’example’@humanforce.com
The minimum permission's required are shown in the screenshot and listed below.
- Payroll admin, this is required to send payroll data such as timesheets from Humanforce to your Xero account when exporting payroll via Humanforce.
- Business and accounting - Standard role, this is treated by Xero as the minimum permission required for access to sync employee data during integration.
7. The invited user needs to accept the email invitation and follow the prompts.
- Ensure to raise a ticket advising which email was used for a consultant to assist from here.
8. The invited user/email needs to login to the developer link: https://developer.xero.com/app/manage
9. Select “New App”
- Enter Name (this should indicate the Organisation from Xero which is being linked)
- Company URL: https:/Humanforce.com (URL is for Xero’s reference, it has no significance to the integration or Humanforce)
- NZ Redirect URL: https://integrationapi.humanforce.com/callback/xeronz/oauth2
- Review and Accept the Terms and Conditions, then press Create App
10. Open the Configuration Menu
11. Make note of the Client ID
12. Generate the Secret and save this as it cannot be retrieved again, if lost the app connection process will need to be restarted from step 8
13. To complete the Integration connection, the Client ID and Secret need to be entered into Humanforce via Integration Central.
- First Ensure a Pay company has been created in Humanforce per Organisation in Xero
- Each organisation will need to repeat the connection process from step 8
14. Upon pressing Connect you will be taken to Xero's portal to login, login using the email account from step 6
15. Review the permissions, select the relevant Organisation from the drop down and allow access to complete the initial setup.
(Only visible if you have multiple organisation setup in Xero)
- Review the available settings in the next pages to tailor the available integration settings
- Employee import can be scheduled to run via the last page
- Employee import can be run manually from the Integration Central home page