HiBob and KeyPay Integration setup for SyncEzy | Scribe

    HiBob and KeyPay Integration setup for SyncEzy

    • Accounts Team |
    • 0 step |
    • 7 minutes
    The following document will outline the standard, already available fields (in white) and the custom, required to be setup fields (in red) within your HiBob account. \ \ These fields are used by the SyncEzy integration to sync your employee account and leave data over to Employment Hero (KeyPay). Once completed, SyncEzy will assist in ensuring these fields are paired correctly in your integration. \ \ Please access the field setup guide by clicking the following link:\ \ <https://docs.google.com/spreadsheets/d/1fi3be0ZLrLxqscH2fR1hFLyrCQaLNgMVgnqIlfvhafk/edit#gid=1330410472>
    HiBob Fields and KeyPay fields. Standard HiBob Fields are white and custom fields to be created in HiBob are highlighted in red.
    If a custom field is to be created, then please note the field type required in HiBob to ensure smooth integration. For example, text field, date field etc.
    Banking fields for Bank account 1: \ \ Use the standard HiBob Account name and Account number fields. \ You will then need to set up custom fields for BSB and allocated percentage. The BSB is to be set up as a text field and the allocated percentage as a list field - defaulted to 100. \ \ **Please note:** the BSB field should contain no hyphens (-) and should always be a complete set of 6 digits when data is entered by the employee.
    Superannuation fields for Super account 1: \ \ If you would like to sync over Superannuation data for your employees from HiBob to Employment Hero (Payroll/KeyPay) you will need to setup the four fields shown below:
    The above fields to be setup are mandatory and required by KeyPay for the integration to create an employee record in Employment Hero (Payroll / KeyPay).\ \ This includes all the following: Basic Details (Name, Start Date, Date of Birth, and Address Details)\ Tax File Declaration (TFN and Employment Type)\ Pay Run Defaults (Default Pay Category, Pay Cycle and Location)\ Locations (at least one)\ Bank Account/s (at least one)\ Super Fund/s (at least one)\ \ All other fields are not mandatory for the integration to sync and create an employee record, however, we do recommend you allow them to be available in the integration so that they can be paired across. It will assist with getting data in to Employment Hero (Payroll/KeyPay) and save you time completing it manually.
    Regarding tax declarations, if you have non-Australian residents, these last two fields should also be created, in addition to fields for working holiday employees. Once you have completed those fields, we can start setting up your Service User account (this is used to connect HiBob to your SyncEzy integration) within your HiBob account.
    Navigate to the ***Settings*** menu in your HiBob account
    Click on ***Integrations***
    Click on ***Manage*** on the Service Users menu
    Click on ***New Service User***
    Click the ***Service User name*** field. \ \ Type the name: ***SyncEzy-KeyPay*** OR ***SyncEzy Integration***
    Click on the ***Service User - Display Name*** field. \ Type a display name - for example: ***SyncEzy-KeyPay Integration***
    Click on ***Next***
    The ***Service User ID*** and ***Token*** will be used to connect HiBob in your SyncEzy integration. These can be accessed when required. Ensure you do not store these anywhere on your computer for security reasons
    Click on ***Done***
    Navigate to the ***Settings*** menu in your HiBob account
    Click on ***Permission groups*** under the ***Account*** menu
    Your business may have a ***Service User*** group already. If not, please click on ***Add permission group***
    Click on the ***Group name*** field\ Type the name: ***Admin Service User***
    This Scribe is in tip-top shape!Leave feedback if there are any issues with this Scribe