Getting started as a new Payroll customer

Use this topic if you are an existing Staffology HR customer and are setting up the integration with Staffology Payroll for the first time.

Before you integrate

In Staffology HR, you must complete the fields listed in this table in employees' records before you integrate HR with Payroll. If any of these fields are missing, the integration will fail.

If you have already imported this data, you can start the integration. If you are not sure, run a Quick Query first. Once you’ve confirmed all required fields are complete, you can start the integration.

HR Tab HR Field
Personal

  • Title

  • Forename

  • Surname

  • Address (minimum 2 lines)

  • Postcode

  • Gender

  • Date of Birth
Contract

  • Start Date

  • Company

  • Country

Payroll

  • Payroll Number

  • NI Number (no spaces)

  • NI Code

Payroll - Bank Details

These fields are not required, but we recommend completing them:

  • Account Number

  • Sort Code

  • Pay Method

If the employee is paid by BACS:

  • From the Pay Method list, select Giro so the payment syncs to Payroll as a credit

  • Do not select BACS, as this prevents the payment from syncing

  • If you leave this field blank, it defaults to Credit when synced

Create a Quick Query

Ultimate, Professional, and Essential packages

You can run a Quick Query to check that all required fields are complete.

To do this:

  1. Open the Quick Queries topic and follow the instructions to create a new query.

    When creating your query, add the following:

    • From the Form list, choose Personal. This relates to My Details > Personal.

    • In the Search Results, select Forenames and Surname.

    Options in the Selected Field list.

  2. Using the Form list again, select Contract.

    • In Select Fields, choose Company

  3. Repeat the same steps to include all fields in the query using this table as a guide.

If all fields required for the integration are complete, you can start the integration.

If any fields are missing, update them in employees' records. You must do this manually, except for the Company field, which you can update in bulk if you are on the Ultimate, Professional, or Essential package.

Refer to Bulk update the Company field for more information.

Foundation package

You cannot use Quick Query. You must check and update each employee record manually.

Bulk update the Company field

Ultimate, Professional, and Essential packages

How you update the Company field in employees' records depends on if all employees in the system work for the same company.

All employees work for the same company:

You can create a Lookup Replacement without filtering employees.

Add this criteria:

  • From the Field list, choose Contract - Company

  • Leave the From list blank

  • From the To list, select the company you want to assign

Employees work for different companies:

Use the Employee Selector first to filter the employees you want to update, then apply a Lookup Replacement.

To do this:

  1. Open the Employee Selector and filter the employees you want to update.

    For example, if all employees in the Manchester office work for the same company, filter by Location/Division and select Manchester.

  2. With the Employee Selector active, create a Lookup Replacement.

    Add this criteria:

    • From the Field list, choose Contract - Company

    • Leave the From list blank

    • From the To list, select the company you want to assign

Foundation package

Individual updates only.

  • You must update all fields in each employee's record individually before completing the integration.

You can now start the integration.

Set up the integration

Create an API Key in Staffology Payroll

  1. Sign in to Staffology Payroll.

  2. Go to the top right of the screen, select your initials, then choose API Keys.

  3. Enter a name and select Create Key. Copy the API key. You will use this in HR.

Activate Staffology Payroll in HR

  1. In Staffology HR, go to System Tools > Utilities > System Configuration.

  2. Within the Payroll Integration section, select Staffology Payroll.

  3. Review the information in the pop-up and select the confirmation box.

    The Integrating Staffology Payroll pop-up.

  4. Select Continue.

  5. Enter your API Key from Staffology Payroll and select Save API Key.

    The screen to add an API key.  

    Link HR and Payroll

  6. Select your HR Company from the list.

  7. Enter your Employer ID from Payroll.

    • To find the Employer ID, in Payroll select your company name from the top menu, then choose Edit Details

      The Edit Details menu item in Staffology Payroll.
       

  8. Select Continue.

Choose whether to add HR employees to Payroll

  1. You are asked if you want to add employees that exist in HR but not yet in Payroll.

    • Select View Employees to open a list of employee names

    If you want to add the employees

    1. Select Yes.

    2. Choose the tax year when HR absence When an employee or worker is absent from work. This can be for a variety of reasons. data should start syncing to Payroll.

    3. Select Check Data.

    4. Continue to Step 17.

    If you do not want to add employees

    1. Select No, then choose Continue.

    2. Skip to Step 18.

Check Data

  1. The system checks for data issues.

    If errors are found

    • Download the report

    • Fix the issues in Staffology Payroll.

    • Return to HR and select Recheck Data

    • Repeat until no errors remain

    • Select Continue and go to Step 18.

    Errors found during the data check.

    No errors

Complete the integration

  1. Review the summary, then select Integrate Companies.

  2. A success message confirms the integration is in progress. You will receive a notification when the first data sync is complete.

    The success message shown at the final step of the integration.

    Learn how toCreate a new payment or deduction, with or without linking to Payroll