Contents
What this integration does
Connecting MyHR to Payworks means new employees are created in your Payworks account automatically when they sign their employment agreement in MyHR. Employee detail changes are sent from MyHR to Payworks, making it easier to keep your employee records up to date.
What is sent from MyHR to your Payworks account
When a new employee is created, MyHR sends the following to Payworks:
- Name, email, phone
- Date of birth, gender
- SIN (Social Insurance Number)
- Address (street, city, province, postal code)
- Province (also used as tax province)
- Start date
- Employment type
- Business number, pay group, and earning description (from your integration settings - configured in Step 3)
- Bank account
- Pay rate
Before you start
You'll need:
- In MyHR: Owner access, or Manager access with the Manage integrations permission
- In Payworks: API access enabled on your account - this requires contacting your Payworks CSR (Step 1 covers how to do this). Allow a few days for Payworks to process the request before you start.
Setting up the integration
Step 1: Get API access from Payworks
Before you can connect anything in MyHR, you need to enable API access on your Payworks account. To do this, contact your Payworks Customer Service Representative (CSR).
To find your CSR: log in to Payworks and click the question mark icon. A dropdown will show your account manager's details.
Your CSR will:
- Confirm you have a signed API License agreement in place
- Enable your Payworks account for API access
- Issue you a Client ID and Secret Key
You may be asked whether you'd like a copy of your account for testing purposes. This isn't required for most customers, so you can decline unless you have a specific reason to test separately.
While you wait, you can browse the Payworks API Developer Portal to get familiar with the setup.
Step 2: Connect Payworks in MyHR
Once you have your Client ID and Secret Key, head to Settings > Integrations > Payworks in MyHR and click Connect.
You'll be asked for three things:
- Customer Number: find this in Payworks under Payroll > Business Info, below the Company Name field. It also appears in the top-right corner of the navigation bar under your company name.
- Client ID: provided by Payworks when your API access was enabled.
- Secret Key: provided alongside your Client ID.
Enter all three and click Connect.
Step 3: Configure your settings
After a successful connection, you'll land on a settings screen. Click Refresh to pull the latest data from your Payworks account, then configure the following:
- Default payroll account: if your business has more than one CRA or business number, choose which one new employees should be added to by default. Most customers have just one, in which case this is set automatically.
- Default pay group: if you have more than one pay group, select the default for new employees. You can view your pay groups in Payworks under Payroll > Pay Groups.
- Pay description mapping: MyHR uses two pay types (Annual salary and Hourly wage). Map each one to the corresponding pay description in Payworks so we know how to categorise people when they're added.
- Payroll administrator: select the MyHR user who will manage the payroll integration going forward.
Step 4: Link your people
For a full guide to the integrations area, including linking, unlinking, and resolving errors, see Navigating integrations in MyHR.
Go to the integration and select a person. Click the accordion next to their name and you'll see two options:
- Add to Payworks: if the person doesn't exist in Payworks yet, this will create them.
- Link to existing: if the person is already in Payworks, link them here. Once linked, any updates you make in MyHR will flow through to Payworks automatically.
Support with your integration
If you're having trouble linking up your employees or have questions about the integration, message the MyHR team via the Ask Us chat feature or call us on - 1 855 694 7224 and the MyHR team will be able to help you out.