Skip to main content

PayHero Field Mappings

Alex Giurioli avatar
Written by Alex Giurioli
Updated over 2 weeks ago

Pricing Plan Banner - Business + Enterprise.png

This article details which fields flow through from Karmly to PayHero for integrated companies. To learn about using Karmly with PayHero see these articles:

Resources are synced to Karmly and created or updated when the candidate is invited, when a manual sync is performed from the user record, or when they're added to a Pay Cycle from the Pays tab. Existing employees in PayHero will also be synced if the integration is synced under Manage > Integrations.

The following details will be updated in PayHero when a resource is synced from Karmly:

PayHero Field

Karmly Source

Display Name

Display Name

First Name

First Name

Last Name

Last Name

Birth Date

Birth Date

Phone

Mobile

Email Address

Email Address

Email Payslips*

This will be ticked if an email address is specified for the resource.

Address

Address - if the Google address picker has been used to select the address, this will flow through to the appropriate Address, Suburb, Town / City and Post Code fields in PayHero. Otherwise, the full address will be inserted into the Address field only.

Employment Basis

Employee if Business is not selected in Karmly, or Contractor if Business is ticked.

Start Date*

Set to the earliest start date of the candidate's Placements, or today's date if no placements are found.

Normal Rate

If the candidate has a single placement their Normal Rate will be set, otherwise it will be left as $0. Rates are still sent through from Karmly for each time entry, this setting is only used for some leave types.

Salary

The salary specified in Karmly will sync through as the 'Annual Salary' in PayHero. This is only applicable for people with the Consultant role.

Bank Account

Bank Account

Tax Code

If there is no Tax Code selected in 'Additional Tax Details' in Karmly, the Tax Code in PayHero will be set to M for employees or WT for businesses*. This will not re-sync on subsequent updates, unless the Tax Code field is later changed in Karmly.

If a Tax Code is selected in 'Additional Tax Details' in Karmly this will be used.

KiwiSaver

If a KiwiSaver Employee Deduction rate is selected in 'Additional Tax Details' in Karmly this will be used.

If not set, or set to 'Not Enrolled', the employee will not have KiwiSaver applied in Karmly. If not set, this setting will not re-sync to PayHero in subsequent updates.

Important: if an employee is on a KiwiSaver Savings Suspension, this needs to be set directly in PayHero. To prevent the integration from overriding this setting, set the employee to 'Not Enrolled' in Karmly.

Tax Rate

Withholding Tax Rate

IRD Number

Tax Number

Trading Name

Trading Name

GST Registered

Ticked if both Business is ticked and a Business Tax Number is set.

GST Number

Business Tax Number

Payslip Type

If Recipient Created Invoice is ticked in Karmly, the Payslip Type in PayHero will be set to BCTI. Otherwise, your company's Default Payslip Type will be selected.

*Updates with an asterisk will only be set on creation of the employee in PayHero - any updates to these fields should be applied directly in PayHero.

Did this answer your question?