|
About KeyPay KeyPay is a cloud-based workforce management and payroll platform. In a single, integrated platform, KeyPay automates the flow of data from employees across rosters, timesheets, leave management, and reporting, providing full client visibility of the pay run at all times. |
Before you start
To setup integration with KeyPay, you will need an API Key and a Business ID:
API Key - is a string of code that is used to authenticate and link your KeyPay account to Xemplo. You can generate an API Key in KeyPay by following these steps.
Business ID - is a unique number assigned to businesses/companies in KeyPay. Your business ID will display when logging into KeyPay in the KeyPay URL:
Generating an API Key
To generate an API Key in KeyPay, an authorised KeyPay Administrator should refer to the following KeyPay guide: https://api.keypay.com.au/guides/BasicAuth
Setting up KeyPay integration in Xemplo
Once you have your API Key and Business ID, you can configure integration between KeyPay and Xemplo in Xemplo.
To setup KeyPay integration:
- Go to Company Settings > Integration and select KeyPay from the list of available integration partners.
Configuring additional integration preferences
| Setting | Purpose |
| Sync Locations |
If set to ON - this will pull across 'locations' found within the Keypay Database into the Xemplo Site Settings Please Note: This option is only available if you have this configured in KeyPay. |
| Auto-Export Expense Request | If set to ON - will automatically export approved expense claims to KeyPay |
| Auto-Export Leave Request | If set to ON - will automatically export approved leave requests to KeyPay |
| Auto-Export Time & Attendance | If set to ON - will automatically export approved time and attendance activity to KeyPay |
| Auto-Export Onboardings |
If set to ON - any onboardings which have been reached the 'completed' status within the onboarding module will push the Personal/Payroll data through to the payroll system. This new onboard will be presented on the dashboard as 'un-finalized employee' which would then require the final payroll-related items entered/saved before they would be 'active' and presented into the subsequent pay runs. |
| Auto-complete Worker Setup |
If set to ON - workers exported from Xemplo to KeyPay will be active employees in KeyPay immediately. If this setting is enabled, you will be prompted to provide a default Location and Pay Category to use for all workers on creation. You can update a worker's Location and Pay category at any time after initial creation. |
Primary Pay Category |
Select the most common pay category used for your workforce. You can update this selection at any time. Please note: If the required pay category does not appear in the list, check your KeyPay configuration. |
Pay Schedule |
Select the most common pay schedule applicably to your workers. You can adjust this later if need be. Please note: If the required pay schedule does not appear in the list, check your KeyPay configuration. |
Expense Category |
Select the most common expense category applicably to your workers. You can always adjust this later if need be. Please note: If the required expense category does not appear in the list, check your KeyPay configuration. |
Work Type |
Select the most common work types applicably to your workers. You can always adjust this later if need be. Please note: If the required work type does not appear in the list, check your KeyPay configuration. |