Integrating with KeyPay Payroll

Setting up the connection with KeyPay

Once you have specified KeyPay as the payroll you wish to integrate with, you will need to take the following steps to connect HR Partner with KeyPay:

1. Click on the "Employees" menu on the left.

2. Click on "Import".

3. Click on "Integration".

On the next screen, fill in your KeyPay API Key (which you can obtain by following these instructions), and your KeyPay Business ID, which you can obtain from KeyPay directly.

Once done, just click the 'Integrate With KeyPay' button, and you are done!

Note

The refresh of your employee data runs in the background, and will remain active until you disconnect the two systems.  It can take several minutes for the initial refresh to run (depending on the number of employees you have), so please be patient.

Disconnecting from KeyPay

As mentioned before, the connection to KeyPay will constantly run in the background until you choose to disconnect it.  To disconnect from KeyPay, simply go to the same Integration screen as above, and click the yellow 'Disconnect From KeyPay' button.  This will only take one second, but after this, your employee information will no longer be synced between KeyPay and HR Partner (however it will remain in HR Partner).

At any time, you can re-establish the connection with KeyPay again, and the system will continue syncing your information between the two platforms.

Manually refreshing data from KeyPay

Even though the automatic refresh between the two systems runs in the background every few hours, sometimes you may want to manually refresh the information from KeyPay into HR Partner.  For instance, you may add a couple of new employee in KeyPay and need to start data entry in HR Partner immediately and cannot wait for the auto refresh to run (which can take up to 6 hours).

In these instances, you can kick off a manual refresh by going to the main dashboard in your HR Partner company and clicking the little refresh icon on the information box that show you the last refresh time:

Warning

Do not run a manual refresh more than once or twice a day.  The process is very resource intensive on our servers, and can impact performance for other customers.  If we detect that too many refreshes are being run on your company, we may disconnect your integration or remove your ability to refresh altogether without notice.

Pushing Leave to KeyPay

This functionality is currently not activated, however, we are working on this as we speak.  Please check back often for updates.