Skip to content

PayHero integration overview ​

See API integration authentication and planning for the cross-integration view of how the partner key is obtained and whether advance planning is needed.

PayHero: Integration configuration ​

ConfigurationDescriptionValues
API keyPartner API key used to authenticate requests to PayHeroText (required)
Employer Subsidy Contribution Tax RateTax rate deducted from Superannuation Employer Contribution, expressed as a percentagePayHero/NZ tax rates lookup
Default pay cyclePayHero pay cycle applied on employee creationPayHero pay cycles
Email payslipsSend payslips via emailSend email payslips if there is a provided email address; Never send email payslips
Default employee status on creationPayHero employee status applied on employee creationPayHero employee statuses
Add holiday pay as you goWhether to apply Holiday Pay As You GoYes, apply holiday pay as you go; No, do not apply holiday pay as you go
Employee labelStatic label applied to all employees created via PICMILabel is added to the employee
Employee label colorHex color code for the static label (defaults to PICMI’s spring green: #25ce81)Hex color
Add role-based labelAutomatically apply a label based on the employee’s role in PICMIYes, apply role-based labels; No, do not apply role-based labels (uses Job Title)
Role label colorHex color code for automatically applied role-based labels (defaults to PICMI’s spring green: #25ce81)Hex color

PICMI-PayHero integration fields ​

Field NameDescriptionValidation/Constraint/Default ValueSource
First nameGiven name of the individual.MandatoryPersonal Information
SurnameFamily name of the individual.MandatoryPersonal Information
Preferred namePreferred name used by the individual, typically the first and surname combined.First + Surname, MandatoryPersonal Information
EmailEmail address of the individual.Personal Information
PhonePhone number of the individual.Personal Information
BirthdateDate of birth of the individual.Personal Information
GenderGender identity of the individual.Gender DiversePersonal Information
Street addressStreet address of the individual.AddressPostal > StreetAddressPersonal Information
CityCity where the individual resides.AddressPostal > RegionPersonal Information
PostcodePostal code for the individual's address.AddressPostal > PostalCodePersonal Information
Emergency contact nameName of the individual's emergency contact.Questions
Emergency contact phonePhone number of the individual's emergency contact.Questions
Bank account numberBank account number of the individual (stripped of dashes).Questions
Tax numberIndividual's tax number (IRD number, stripped of dashes).MandatoryQuestions
Tax codeTax code applicable to the individual.MandatoryQuestions
Start dateStart date of employment or contract.Today + 1 day, MandatoryJob
Job titleTitle of the individual's position.Job
KiwiSaver pre-existing memberIndicates if the individual is a pre-existing KiwiSaver member.Changable on KiwiSaverStatus contribution rate mappingQuestions
KiwiSaver rateContribution rate for KiwiSaver.Changable on KiwiSaverStatus contribution rate mappingQuestions
KiwiSaver opt-out dateDate set when an individual opts out of KiwiSaver.Changable on KiwiSaverStatus contribution rate mappingQuestions
Enrolment dateDate of enrolment in KiwiSaver.Changable on KiwiSaverStatus contribution rate mappingQuestions
Employer subsidy contribution tax rate (esct)Tax rate for employer subsidy contributions.Integration Configuration
Pay rateRate of pay for the individual.Job
Salary flagIndicator for salary employment type; must be set to avoid API errors.FALSE, MandatoryIntegration Configuration
Contractor flagIndicator for contractor employment type; must be set to avoid API errors.FALSE, MandatoryIntegration Configuration
Active flagStatus indicator for employment; defaults to TRUE if active.TRUEIntegration Configuration
Email pay slipsPreference for receiving payslips via email.Email payslip to provided email addressIntegration Configuration
Payment cycleCycle for payment processing.API + No Pay Cycle, No PayCycleIntegration Configuration

Customer API credentials ​

To create an employee in PayHero, PICMI needs API credentials belonging to your own PayHero company.

note

Do not use another organisation's API key or a personal credential. Your PayHero credentials should only be used for your own company's connection.

Apply for PayHero API access ​

PayHero documents private integrations for companies on its Universe plan. Review the PayHero API integration requirements, complete the private integration application, and email it to api@flexitime.works.

PayHero says it will respond within 10 working days. Once your application is approved, use the credentials PayHero issues for your company and enter the required API credential in PICMI.

note

PayHero also documents a separate partner-integration process. That process is for software providers building an integration for multiple PayHero customers, not for a customer connecting its own PayHero company to PICMI.

General troubleshooting ​

How long does it take for PayHero to respond to a private API application?

+

Where do I get the PayHero API credential for my company?

+

I have an invalid PayHero API credential error, what should I do?

+

PICMI is the simple hiring tool that helps make your job their first choice