KeyLink integration overview

The KeyLink integration allows PICMI to generate CSV files formatted for ingestion by the Platinum Payroll system.

Integration configuration

Configuration	Description	Values
Employer Subsidy Rate	Rate of employer subsidy contribution	Percentage number 0 or 3
Province	When the public holiday is for the region	Regions NTL, AUK, WKO, BOP, GIS, HKB, TKI, MWT, WGN, NSN, MBH, TAS, WTC, CAN, OTG, STL (Note OTG is not ISO 3166:2 OTA standard for Otago)
Payroll	The payroll identifier used by KeyLink to determine which pay rules to apply	Text (required)
Employment Type	Default employment type	KeyLink codes such as FIX, CAS, PRU
Ordinary Pay Rate	Standard ordinary pay rate	Text
Leave Set	Default roster configuration	Text
Work Area	Assigned work area	Text
Rate Set	Default rate configuration	Text
Roster Set	Default roster configuration	Text
Employer Subsidy Contribution Tax Rate	ESCT tax rate on employer subsidy contribution	10.5%, 17.5%, 30%, 33%, 39%
Convert name to simple characters	Used to ensure bank account names are acceptable to banks on integration	Leave name as typed by the job seeker; Send name without macrons and special characters

PICMI–KeyLink integration fields

Field Name	Required (KeyLink)	Description / Notes	Additional Rules / Valid Values	Source
Employee Code	Not required	KeyLink will generate this value upon import	Should leave empty
Other Code	Required	External identifier for the employee, generated according to predefined rules	—	Integration Defaults
Surname	Required	Employee’s last name	—	Questions
Forenames	Required	Employee’s given names	—	Questions
Preferred Name	Optional	Defaults to Forename if empty	—	Questions
Previous Name	Optional	Previously known name	—
Gender	Optional	Defaults to gender of another person with same first name; otherwise Unknown	M, F, N, O, P, U: Male,Female, Non-binary, Other, Prefer not to say, Unknown	Questions
Title	Optional	Honorific title	—
Date Of Birth	Required	Birthdate	dd/MM/yyyy	Questions
HOME ADDRESS1	Optional	Primary street address	—	Personal Information (Jobseeker)
Home Address2	Optional	Second address line	—	Personal Information (Jobseeker)
Home Address3	Optional	Second address line	—	Personal Information (Jobseeker)
City	Optional	City/suburb	—	Personal Information (Jobseeker)
State	Optional	Region	—	Personal Information (Jobseeker)
Post Code	Optional	Postal code	—	Personal Information (Jobseeker)
Country	Optional	Country	—	Personal Information (Jobseeker)
POSTAL ADDRESS1	Optional	Postal address line 1	—
Postal Address2	Optional	Postal address line 2	—
Postal Address3	Optional	Postal address line 2	—
City	Optional	Postal city	—
State	Optional	Postal region	—
Post Code	Optional	Postal postal code	—
Country	Optional	Postal country	—
Home Phone	Optional	Home phone	—
Work Phone	Optional	Work phone	—
Other Phone	Optional	Additional phone	—
Mobile	Optional	Additional phone	—	Personal Information (Jobseeker)
Fax	Optional	Fax number	—
Personal Email	Required	Primary email address for communication	—	Personal Information (Jobseeker)
Work Email	Optional	Organisation-assigned address	Defaults from organisation settings
Email Password	Optional	Uncommon field for work email systems	—
Marital	Optional	Marital status	—
Residency	Optional	Residency classification	—	Questions
Residency Expiry Date	Optional	Visa/residency expiry	—	Questions
Ethnic Origin	Optional	Ethnic origin	—
Nationality	Optional	Nationality	—	Questions
Place of Birth	Optional	Birthplace	—
Languages	Optional	Languages spoken	—
IRD Number	Required	NZ tax identifier	Validated	Questions
Tax Code	Required	NZ tax code	Validated	Questions
Company Start Date	Required	Employment start date	—	Job
Employment Start	Optional	Defaults from Company Start	—
Lve Service Date	Optional	Defaults from Company Start	—
Industry Start	Optional	Defaults from Company Start	—
Other Date	Optional	Additional date field	—
Termination Date	Optional	Employment end date	—
Bank Account	Required	New Zealand Bank account number	Validated	Questions
Next Kin	Optional	Next of kin	—	Questions
Relationship	Optional	Relationship to next of kin	—	Questions
Address1	Optional	Next of kin address 1	—	Questions
Address2	Optional	Next of kin address 2	—	Questions
Address3	Optional	Next of kin address 3	—	Questions
City	Optional	Next of kin city	—	Questions
PostCode	Optional	Next of kin post code	—	Questions
Day Phone	Optional	Daytime phone	—
Mobile	Optional	Evening phone	—	Questions
Emp Record Start Date	Optional	Effective date of record	Defaults same as Company Start	Job
Emp Record End Date	Optional	Record end date	—
Payroll	Required	Payroll group	Match payroll values eg PRU-W	Integration Configuration
Employment Type	Default	KeyLink employment type	Match payroll values eg FIX, CAS-SH (must be set)	Integration Configuration
Leave Set	Default	Leave configuration	Defaults to 3%	Integration Configuration
Province	Default	Regional province	NZ Region NTL, AUK, WKO, BOP, GIS, HKB, TKI, MWT, WGN, NSN, MBH, TAS, WTC, CAN, OTG, STL (Note OTG is not ISO 3166:2 OTA standard for Otago)	Integration Configuration
Union	Optional	Union membership	—
Award	Optional	Award category	—
Band	Optional	Pay band	—
Flexible Entity1	Optional	Costing dimension	—
Flexible Entity2	Optional	Costing dimension	—
Flexible Entity3	Optional	Costing dimension	—
Flexible Entity3	Optional	Costing dimension	—
Approved By	Default
PRIMARY Position	Default
Job Desc	Optional	Description of job
Work Area	Default	Work area code	Match payroll values	Integration Configuration
Rate Set	Default	Rate set code	Match payroll values	Integration Configuration
Roster Set	Default	Roster set code	Match payroll values	Integration Configuration
Sun Hrs	Optional	Hours Sunday	—
Mon Hrs	Optional	Hours Monday	—
Tue Hrs	Optional	Hours Tuesday	—
Wed Hrs	Optional	Hours Wednesday	—
Thu Hrs	Optional	Hours Thursday	—
Fri Hrs	Optional	Hours Friday	—
Sat Hrs	Optional	Hours Saturday	—
TA RuleSet	Optional	Time-recording rate set	—
Trigger Set	Optional	Time-recording rate set	—
Ord Pay Rate	Default	Ordinary rate code	payroll eg ORD	Integration Configuration
Ord Rate From Date	Optional	Effective date for ordinary rate	Defaults from Company Start
Rate	Required	Rate numeric value	—	Job
Value	Optional	Additional numeric value	—
KS Type	Required	KiwiSaver type	E18, E65, ECS, ENR, ETE, HOL, MEM, OUT, SUS, NON: Exempt Under 18, Exempt Over 65, Exempt Casual, Exempt Non-Resident, Exempt Temporary, Contribution Holiday, Member, Non-Member, Opted Out, Suspension, Employee Non-Resident	Questions
KS Eff Date	Optional	KiwiSaver effective date	Defaults from Company Start	Questions
KS Employee %	Required	Employee KS %	Defaults to 3%	Questions
KS Employer %	Optional	Employer KS %	Defaults to 3%	Integration Configuration
ESCT Rate	Optional	ESCT %	Defaults to 17.5%	Integration Configuration
Reports to Group	Optional	Reporting group	—

Download Report

• see reports

General troubleshooting

• General integration troubleshooting
• Integration FAQs