Welcome!

Our Partner Resources are here to help you and your clients make the most of KeyPay's extensive features.

Partner updates

Keep up to date with the latest KeyPay features and developments.

8 October 2021

Introducing: Bureau Dashboard! Available now


We’re excited to launch a new product to bureaus - KeyPay’s Bureau Dashboard!

With KeyPay’s Bureau Dashboard, you can consolidate all your pay run activities in one place so you’ll always have a bird’s eye view of what’s coming up for you and your team.

Key highlights:

  • Prioritise important activities that require your attention
  • Visualise your team’s progress and workload capacity
  • Save even more time by performing bulk actions like creating and finalising pay runs in just a few clicks

Learn more about the Bureau Dashboard here and via the relevant support articles: AU | UK | NZ | SG | MY

Changes to ‘White Label / WL’ terminology in KeyPay

As of today you may notice some changes with reference to the terminology used for ‘White Label / WL’ within the KeyPay product. In order to better reflect KeyPay’s branded solution, the term ‘White Label / WL’ will soon be changed to ‘Brand’. Please note that this change in terminology will not affect existing functionality in any way, and is merely a tweak to better describe the branded payroll element for our partners.

Note to API users:
We have added new endpoints and properties to existing APIs to reflect this new branded solution. First and foremost, we want to highlight that none of these additions will affect existing API users. So, what have we done specifically?

Firstly, we are retaining these existing endpoints:

  • GET /api/v2/whitelabel/{whiteLabelId}/reports/activeemployees
  • GET /api/v2/whitelabel/{id}
  • GET /api/v2/whitelabel
  • GET /api/v2/whitelabel/{whitelabelId}/reports/signups
  • GET /api/v2/whitelabel/{whiteLabelId}/Invoice/{id}
  • GET /api/v2/whitelabel/{whiteLabelId}/Invoice/{id}/excel
  • GET /api/v2/whitelabel/{whiteLabelId}/Invoice/{id}/pdf
  • GET /api/v2/whitelabel/{whiteLabelId}/Invoice

But, we have also created new endpoints that replace ‘whitelabel’ with ‘brand’ and replace ‘whiteLabelId’ with ‘brandId’.

Secondly, we have included a new property - ‘brandName’ - in the InvoiceModel resource. This new property serves the exact same purpose as the existing
property ‘whiteLabelName’.

As stated above, we've designed these API changes to have no impact on any existing API functionality. When you're ready, you can move over to using the new endpoints/properties. Until such time, it’s business as usual!

5 October 2021

Release of 'split earnings by location' feature
Available Wednesday 6 October 2021

In the partner update sent earlier in the month we advised that we were planning on releasing a 'split earnings by location' functionality. This release allows users to automate the distribution of earnings across various locations for auto pay salaried employees as a set percentage.

We are pleased to announce that this will be available on Wednesday 6 October 2021.

For detailed information regarding the 'split earnings by location' functionality please see the relevant support article: AU | UK | NZ | SG | MY

Addition of Microsoft Dynamics 365 Business Central integration

This is a quick update to let users know that Microsoft Dynamics 365 Business Central is available as a journal integration. It is available in AU, UK and NZ.

Please see the relevant support article for more information: AU | UK | NZ

30 September 2021

Update on mandatory leave allowance changes

In early August, we advised in this partner update that we were planning on making the 'Leave allowance template' (LAT) field that exists within an Employee file > Pay run defaults page, mandatory as at 1 October 2021 (AU region only).

Based on user feedback, we have delayed the release date and are no longer going to make this mandatory. We are working on alternate approach and will communicate further developments as they happen.

Timesheets and daylight savings

Daylight saving time will begin at 2:00am this Sunday 3 October 2021, and will impact timesheets that include shifts covering the 2-3am hour that is lost when clocks roll forward. When the system imports these timesheets into the pay run, it will not automatically remove the 'lost' hour so will for example, interpret a 1am-5am timesheet as 4 hours instead of 3 hours.

As such, any timesheet covering the 2-3am hour will need to be manually adjusted in the pay run for the employees who are affected by the DST crossover.

Are you a member of CA ANZ?


We’re partnering up with CA ANZ to help more people find success with KeyPay! We’d love to hear from our partners affiliated with CA ANZ to get an understanding of their goals and challenges and to hear more about their experience with KeyPay.

Simply reach out here if you’re available to share your thoughts. We’d greatly appreciate your insight!

19 September 2021

IRD employee deductions can now be paid directly to Inland Revenue via the payment file


Currently, businesses can choose to include the total PAYE amount in the payment/bank file for each pay run. To set this up, it was simply a matter of ticking the "Pay PAYE via payment file to a nominated bank account" checkbox in the applicable pay schedule setting. Taking advantage of this feature meant that a business did not then need to worry about an additional manual process of transferring funds to Inland Revenue for PAYE.

We have enhanced this existing functionality to include, in addition to PAYE, the following additional deductions in the payment/bank file:

  • Child support deductions
  • Student loans
  • KiwiSaver employee deductions
  • KiwiSaver employer contributions
  • ESCT

This significantly simplifies the process of paying the above deductions to Inland Revenue in that it can now be done as one single payment via the payment/bank file after each pay run.

To set this up, simply tick the "Pay IRD payments via payment file to a nominated bank account" checkbox in the applicable pay schedule setting and enter the bank account details. It's as simple as that!

Existing businesses that had already ticked the "Pay PAYE via payment file to a nominated bank account" checkbox don't need to do anything to take advantage of this enhancement. This new feature, released today, will automatically apply as the old setting has been consolidated with the above new setting.

Please refer to our pay schedule support article for further detailed information.

Additional bank account fields to support 3rd party deductions


Employees can choose to have authorised amounts deducted from their net earnings to be paid directly to a 3rd party's bank account. In order to provide the 3rd party complete transparency and include all the information needed to identify the sender of the funds, we have added two additional fields in the employee's Bank Accounts screen.

The two new fields, named 'Particulars' and 'Code', will appear against any employee bank account (in both the business and employee portal) where the account type = electronic. Additionally, the value entered in these fields will automatically populate in a pay run's payment file. In conjunction with the existing 'Payment reference' field, which can be found in an employee's recurring deduction record or against an employee's deduction in the pay run, using all 3 fields will be benefit all parties when setting up deductions to 3rd parties such as charitable institutions for payroll giving deductions.


Note to API users:

As part of this work, we have added the two new properties to all requests using the NzBankAccountModel resource.

We've designed these changes to have no impact on our existing API users. When you're ready to start using these new properties you can just include the new properties in the data you send in your PUT and POST requests to take advantage of the new functionality. To be clear, if any of the new properties are not included in any PUT/POST request, no changes will be made to any existing values contained in the new fields.


Note regarding WorkZone:

This release does not include any updates to WorkZone, which means that the two new additional fields cannot be viewed or edited by employees in WorkZone. This will be worked on at a later stage.

Please refer to our employee bank account support article for further detailed information.

9 September 2021

Split earnings by location feature coming soon!

Although current functionality allows earnings to be split across various locations, it requires a manual process and specific hours allocated as opposed to a percentage of earnings. With the release of the 'split earnings by location' functionality, users will be able to automate the distribution of earnings across various locations for auto pay salaried employees as a set percentage.

This will be configurable at an employee level via the 'Pay run defaults' page. Once the 'Split earnings by location' setting is enabled, the system will create separate earning lines within the pay run in order to calculate the earnings split per location. This will then flow through to journals and payroll reports.

NB: Earnings can only be split for auto pay salaried employees, NOT for timesheet employees or those on Advanced standard hours.

For our API users, the split earnings by location functionality will have NEW API end points, these include:

  • Get Employee earnings line splits:
  • GET: employee/{employeeId}/earningslinesplit
  • Get Earnings line split by location ID:
  • GET: employee/{employeeId}/earningslinesplit/{locationId}
  • Update Earnings line split:
  • PUT: employee/{employeeId}/earningslinesplit/{locationId}
  • Create Earnings line split:
  • POST: employee/{employeeId}/earningslinesplit
  • Delete Earnings line split:
  • DELETE: employee/{employeeId}/earningslinesplit/{locationId}

The API reference document will be updated to include the following changes when they take effect.

We will send through another update with detailed information on this feature closer to the release date within the next two weeks.

We’re also celebrating the announcement of yet another new feature this week!

It's easy to check who has acknowledged a document in KeyPay using our Employee Details Audit Report.

After listening to your feedback - You can now also keep track of who hasn’t acknowledged a document with the release of our new Document Acknowledgement Report.

This new report will be a priceless tool in ensuring everyone reads and acknowledges your vital updates and documents, helping you to maintain compliance in the process.

Take a look here to see how to access the report and make it work for you.

P11Ds - Now available in Workzone


Building on our original Payrolling Benefits and P11Ds releases earlier this year. Employees who have WorkZone enabled can now view their P11Ds in the WorkZone app, giving them (and you) more options and flexibility when it comes to accessing important documents.

3 September 2021

Superfund data clean up & improvements

Effective 10 September 2021


We have just undertaken extensive work relating to several improvements in the super fund functionality, with the intention of cleaning up the data and streamlining the process for future. Below is a list of issues that had been identified as problematic, and a quick note on the changes implemented for each.

No more multiple entries for funds with the same USI
Previously we linked employees to a super fund by matching on Product Code, ABN, or Name via the unstructured employee end point, and we chose the first match, if multiple matches were found. Super products can change name and ABN over time, which led to multiple entries for the same Product Code, aka Unique Superannuation Identifier (USI). To resolve this issue we'll now be keeping the ABN and super fund name up to date for a current USI by updating these nightly, however there could be a delay (a day or two) if the number of synced funds exceed the system limit.

Search tool improvement

When searching for super funds via the UI a warning is displayed if more than 20 matches are found as only the first 20 are displayed. We implemented this to avoid the scenario where users are unable to find the required super fund.

Changes to the API

These changes include a new SearchBy parameter on GET endpoint /api/v2/business/{businessId}/superfund/productsearch. This now defaults to SearchBy 'All' and is backward compatible. In light of these changes, API users searching by USIs or ABNs should see improved performance.

Frequently asked
questions

When does invoicing occur?

You will receive your invoices on the 1st of each month and payment is taken on the 8th of each month.

How is monthly billing achieved for our branded payroll solution?

If you have a branded payroll solution in place KeyPay will never bill your clients directly. As a partner, you are required to bill your clients. KeyPay will invoice you directly each month.

How is billing calculated?

You will only receive a per employee monthly charge for active employees. An employee will be considered ‘active’ when at least one of the following actions has been completed for that employee during a calendar month:

  • Included in a finalised pay run (even if that pay run is subsequently unlocked)
  • Has had an approved leave request                        
  • Has had an approved expense request
  • Has had a published roster shift
  • Has had an approved timesheet

Can we access a demo payroll business?

KeyPay doesn't provide pre-filled demo accounts. If you wish to create a demo account you can make a test business in your branded payroll solution. Trial periods are not automatically available so you will need to request this by contacting: