KeyPay helps businesses easily manage award compliance and award updates. KeyPay has a rostering and time and attendance module, they also have an employee self-service app for users to look at their roster, clock and out, apply for leave and view payslips.
intelliHR has built a custom integration layer that is available for users of KeyPay UK. The integration takes new hires in intelliHR and sends them to KeyPay payroll. This integration also sends any updates made to a person or job record on intelliHR to KeyPay Payroll. You can also trigger KeyPay's self-service onboarding module via the integration.
This article covers:
- What the Integration will do?
- What is currently not included in the integration?
- What data can be mapped from intelliHR to KeyPay?
- Connection & Set-up Costs
What will it do?
✅ When a new job (new hire) is created in intelliHR, a new user is created in KeyPay.
✅ The KeyPay employee onboarding self-service module can be triggered via the integration.
✅ When a job is updated in intelliHR, the associated user in KeyPay is also updated.
✅ When a person is updated in intelliHR, the associated user in KeyPay is also updated.
Common Considerations
- KeyPay's API is region dependant, so it's important to confirm the KeyPay account's region. If you're a user of KeyPay in AU or NZ; please check out our corresponding article for these regions here.
- KeyPay tenants can contain multiple companies, so a relevant lookup attribute needs to exist in intelliHR (usually an associated business entity).
Data Mapping
Below is a list of fields that can be mapped across from intelliHR to KeyPay for the New User creation process (triggered by a job being created in intelliHR).
Where "Custom Field" is stipulated as the intelliHR field, a custom field will need to be created within intelliHR. For more information on how to do this; refer to our Custom Field article.
| intelliHR Field | KeyPay Field |
| Business Entity | Business ID |
| Title | Title |
| First Name | First Name |
| Last Name | Surname |
| Gender | Gender |
| Employee Number | External ID |
| Primary Email Address | Email Address |
| Date of Birth | Date of Birth |
| Work Class | Employment Type |
| Position Title | Job Title |
| Company Start Date | Start Date |
| Primary Phone Number | Mobile Phone |
| Not stored in intelliHR; can be hard coded as false. | Residential Address is Overseas |
| Country | Residential Country |
| Postcode | Residential Postcode |
| Street Address | Residential Street Address |
| Suburb | Residential Suburb |
| Pay Cycle | Pay Schedule |
| Hours Per Cycle | Hours Per Week |
| Base Annual Salary / Base Hourly Rate | Rate |
|
Custom Fields (Person, Job or Job Remuneration custom fields depending on preference). |
Tax File |
| Rate Unit | |
| Primary Pay Category | |
| Leave Template | |
| National Insurance Number | |
| Tax Calculation Method | |
| National Insurance Category | |
| Employee Statement | |
| Is Enabled for Timesheets |
Connection & Set-up Costs
Steps required to connect the integration and the costs associated are quoted on a case-by-case basis as this integration is facilitated by an intelliHR custom integration layer.
intelliHR will provide a quote that factors in some of the following activities to ensure that the integration is sustainable for each client.
- Authentication Testing: Requires the client to retrieve an API key from within KeyPay admin settings and confirmation of tenant region.
- Field Mapping: As per the section above; ensuring all fields are mapped correctly between intelliHR and KeyPay.
- Pre-Deployment & Post-Deployment Consultations: This includes testing the integration with the client to identify use cases and field mapping requirements.
- Deployment: The end-to-end building of the complete integration/automation process.
- Housing & Maintenance: Which party will be hosting the integration (intelliHR vs. Client)? What effort will be required to troubleshoot and maintain the integration long-term?