SmoothPay integration overview

note

Warning: Bank Account is not yet supported by the PICMI-SmoothPay integration through the API—it is a known issue to SmoothPay.

SmoothPay: Integration configuration

Configuration	Description	Values
API key	Integrations available in the system	Text (required)
Contract Type		SmoothPay contract types
Employment Type		SmoothPay employment types
Payment Type		SmoothPay payment types
Employer Subsidy Contribution Tax Rate	Tax rate that will be deducted from Superannuation Employer Contribution, expressed as a percentage	SmoothPay tax rates
Payslip Type		SmoothPay payslip types
Wage Type		SmoothPay wage types
Days per week		Number
Hours per day		Number
Hours per week		Number
Irregular (NZ only)	Important for NZ Holidays Act interpretation of Ordinary Weekly Earnings	Yes; No
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-SmoothPay integration fields

Field Name	Description	Validation/Constraint/Default Value	Source
Id	Unique identifier for the employee in the integration system	Mandatory	Integration Configuration
First name	The first name of the employee	(special characters are optionally stripped if set in configuration)	Personal Information
Surname	The surname of the employee	(special characters are optionally stripped if set in configuration)	Personal Information
Email	Email address of the employee		Job
Address	The postal address of the employee	Comma-separated lines will be converted to multi-line, eg Don't include town or postcode	Personal Information
Birthdate	The date of birth of the employee	Format: YYYY-MM-DD	Job
Gender	The gender of the employee	M [default] or F	Personal Information
Contract	Type of employment contract	Permanent [default], Temporary, Casual, Contractor/Agent	Integration Configuration
Days per week	Number of days the employee works per week	Default 5	Integration Configuration
Employment	Employment type of the employee	Full time [default], Part time, Piece worker	Integration Configuration
ESCT rate	Employee’s ESCT (Employer Superannuation Contribution Tax) rate	Decimal	Integration Configuration
Hours per day	Number of hours the employee works per day	Default 8	Integration Configuration
Hours per week	Number of hours the employee works per week	Default 40	Integration Configuration
Irregular	Indicates if the employee has irregular work patterns	true false [empty]	Integration Configuration
KiwiSaver status	Employee's KiwiSaver enrolment status	T/F (enrolled)	Questions
Payment	Payment method for the employee	Cash, Cheque, Direct credit [default]	Integration Configuration
Payslip	Payslip delivery method for the employee	Normal (print/email) [default], no payslip, email only, print only	Integration Configuration
Phone	Contact phone number of the employee		Personal Information
Postcode	The postcode of the employee's address		Personal Information
Pre-tax earnings	Pre-tax earnings of the employee		Personal Information
Visa status	Employment visa status of the employee		Questions
Start date	The start date of the employee’s contract	Format: YYYY-MM-DD start date, defaults to today	Job
Family name	The last name of the employee	Mandatory	Personal Information
Tax code	The tax code applicable to the employee	NZ: CAE, EDW, M, MSL, ME, MESL, ND [default], NSW, S, SSL, SB, SBSL, SH, SHSL, ST, STSL, STC, WT	Personal Information
IRD number	The IRD number for tax purposes		Questions
Town	The town or region of the employee's address		Personal Information
Wage type	Type of wage payment for the employee	waged [default], variable salary, fixed salary, net salary (NZ only)	Integration Configuration

FAQs

SmoothPay errors because of special characters in the name. What can I do?

+

General troubleshooting

• General integration troubleshooting
• Integration FAQs