Payslip Components – New Zealand

Default Component Name

Description

Field

What does it display?

Is it included by default?

Heading

Displays a heading for the payslip.

None.

Literal header text as defined by the component label.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) below for a list of the available fields and what each field displays.

No

Logo

Displays a logo/image on the payslip.

Allows you to browse for and select an image file that is to be displayed as a logo on the payslip. Acceptable file types are PNG, .JPEG, .BMP, .GIF and a size limit of 1Mb applies.

Alternatively, select the Use Pay Company Logo field to automatically use the logo of the applicable pay company on the payslip.

Pay Company Details

Groups employer details on the payslip

PayCompanyName

Displays the name of the pay company that issues the payslip.

Yes

PayCompanyTradeName

Displays the trade name of the pay company that issues the payslip.

Yes

PayCompanyIRDNumber

Displays the New Zealand IRD Number of the pay company that issues the payslip.

Yes

PayCompanyGSTNumber

Displays the goods and services tax number of the pay company that issues the payslip.

Yes

PayCompanyAddressLine1

Displays Address line 1 of the mailing address of the pay company that issues the payslip.

Yes

PayCompanyAddressLine2

Displays Address line 2 of the mailing address of the pay company that issues the payslip.

Yes

PayCompanyAddressLine3

Displays the mailing suburb, postcode and area code of the pay company that issues the payslip.

Yes

PayCompanyPhone

Displays the phone number of the pay company that issues the payslip.

Yes

PayCompanyEmail

Displays the email address of the pay company that issues the payslip.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payee Details

Groups information about the payee on the payslip.

PayeeName

Displays the name of payee to whom the payslip belongs.

Yes

PayeeAddress1

Displays Address line 1 of the mailing address of the payee.

Yes

PayeeAddress2

Displays Address line 2 of the mailing address of the payee.

Yes

PayeeAddress3

Displays the mailing suburb, postcode and area code of the payee.

Yes

EmploymentType

Displays the payee's employment type (available from v11.38 onward)

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payslip Header Details

Groups summary information about the payslip.

PayBatchNumber

Displays the pay batch number that uniquely identifies the pay batch in which the payslip was generated.

Yes

HomeOffice

Displays the agency office by which the candidate, to whom the payee is linked, is managed.

Yes

@CurrentDate

Displays the date on which the payslip was generated.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payslip Details

Groups additional information about the payslip.

PayeeNumber

Displays the payee number that uniquely identified the payee.

Yes

PayeeName

Displays the name of the payee.

Yes

PayPeriodEndDate

Displays the last date of the pay period to which the payslip corresponds.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payslip Items
/Allowances

Groups pay items, allowances and leave item details.

TimesheetCode

Displays the timesheet code, as defined in the timesheet header, of the timesheet on which the item appeared.

Yes

ProjectCode

Displays the project code with which the pay item or allowance is associated.

Yes

ClientName

Displays the name of the agency client

Yes

JobCode

Displays the ID that uniquely identifies the job order to which the pay item or allowance corresponds.

Yes

JobOrderPosition

Displays the name of the job position the payee was working in when the pay item or allowance occurred.

Yes

Item

Displays the pay code against which the pay item or allowance was paid.

Yes

ItemDate

Displays the date on which the pay item or allowance occurred.

Yes

Quantity

Displays the quantity of the pay item or allowance that was paid.

Yes

Rate

Displays the rate which the pay item or allowance was paid.

Yes

ItemTotal

Displays the total amount the payee was paid for the pay item or allowance.

Yes

JobOrderClientPosition

Displays the name of the job position, as referred to by the agency client, the payee was working in when the pay item or allowance occurred.

No – additional database field option

MaxTimesheetEndDate

Displays the end date of the latest timesheet that was paid.
This field can be used in conjunction with the Min Timesheet Start Date field to show the date range of timesheets that are paid on the payslip.

No – additional database field option

MinTimesheetStartDate

Displays the end date of the earliest timesheet that was paid.
This field can be used in conjunction with the Max Timesheet End Date field to show the date range of timesheets that are paid on the payslip.

No – additional database field option

TimesheetEndDate

Displays the end date of the timesheet to which the pay item or allowance corresponds.

No – additional database field option

PaycodeSortOrder

Displays the sort order that is assigned to a Pay Code. This field can be used to sort pay items by the Pay Code sort order.

No – additional database field option

Deductions

Groups deduction-item details in a grid format
Note: this also applies to deductions for superannuation (i.e. salary sacrificed superannuation contributions) .

DeductionName

Displays the name of the deduction deducted from the payees earnings.

Yes

DeductionType

Displays the type of deduction deducted from the payees earnings (for example: Child Support)

Yes

AccountName

Displays the name of the account into which the deduction was paid.

Yes

AccountNumber

Displays the account number of that uniquely identifies the account into which the deduction was paid.

Yes

Total

Displays the total amount that was deducted from the payee's earnings for the listed deduction.

Yes

AccountReference

Displays the payee account reference, if defined on the payee deduction, or the account reference as defined on the deduction header.

Alternatively, if the deduction is applied as an ad-hoc deduction, this field displays the account reference that was keyed at the time of adding the ad-hoc deduction into a pay batch.

No – additional database field option

Leave Balances

Groups leave related details.

Name (Heading)

Displays the name of a leave type to which the payee is entitled.
Note: a leave type do not display on a payslip unless the Show on Payslip option is enabled for the leave type when it is configured in Portal > Leave > Leave Maintenance.

Yes

Balance - Hours

Displays the total entitlement balance (quantity) for the leave type as at the date of the payslip.

Yes

Balance - $

Displays the monetary cost of the leave balance, calculated as balance hours x average rate of accrual.
This value cannot be displayed for leave types that are configured to accrue a fixed number of hours or days.

No – additional database field option

Payslip Totals

Groups figure totals on the payslip

None

Literal header text as defined by the component label.

Yes

CurrentGross

Displays the payee's total gross earnings in the pay batch in which the payslip was generated.

Yes

CurrentTotalAllowances

Displays the total amount of allowances paid to the payee in the pay batch in which the payslip was generated.

Yes

CurrentWithholdingTax

Displays the total amount of tax withheld from the payee's earnings in the pay batch in which the payslip was generated.
This amount excludes any extra tax deducted from the payee's earnings in the form of gross or net deductions.

Yes

CurrentTotalDeductions

Displays the total amount of all deductions deducted from the payee's gross or net earnings in the pay batch in which the payslip was generated.

Yes

CurrentEmployerKiwiSaver

Displays the total amount of KiwiSaver contributions accrued in the pay batch in which the payslip was generated.

Yes

CurrentTotalESCT

Displays the total amount of Employer Superannuation Contributions Tax (ESCT) payable on the KiwiSaver contributions accrued in the pay batch in which the payslip was generated.

Yes

CurrentNet

Displays the payee's net earnings in the pay batch in which the payslip was generated.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payslip Totals -YTD

Groups year-to-date totals on the payslip.

None

Literal header text as defined by the component label.

Yes

YTDGross

Displays the payee's year-to date gross earnings, as of the date the payslip was generated.

Yes

YTDTotalAllowances

Displays the total allowances paid to the payee
year-to-date, as of the date the payslip was generated.

Yes

YTDWithholdingTax

Displays the total amount of tax withheld from the payee's earnings year-to-date, as of the date the payslip was generated.
This amount excludes any extra tax deducted from the payee's earnings in the form of gross or net deductions.

Yes

YTDTotalDeductions

Displays the total amount of deductions deducted from the payee's gross and net pay year-to-date, as of the date the payslip was generated.

Yes

YTDEmployerKiwiSaver

Displays the total amount of employer KiwiSaver contributions accrued by the payee year-to-date, as of the date the payslip was generated.

Yes

YTDTotalESCT

Displays the total amount of Employer Superannuation Contributions Tax (ESCT) payable on the KiwiSaver contributions accrued by the payee year-to-date, as of the date the payslip was generated.

Yes

YTDNet

Displays the payee's year-to date net earnings, as of the date the payslip was generated.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) below for a list of the available fields and what each field displays.

No

Payslip Message

Groups messages to be displayed on the payslip

PayCompanyMessage

Displays the payslip message, as defined on the Payslip Details tab of the Pay Company record.

Yes

PayeeMessage

Displays content of the Payslip Message field from the
Employment/Payslip Details tab of the Payee record.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) below for a list of the available fields and what each field displays.

No

Payslip KiwiSaver Employer Contribution

Groups employer KiwiSaver contribution information on the payslip.

None

Literal header text as defined by the component label.

Yes

KiwiSaverAmountYTD

Displays the total amount of employer KiwiSaver contributions accrued by the payee year-to-date, as of the date on which the payslip was generated.

Yes

KiwiSaverAmountPeriodTD

Displays the total amount of employer KiwiSaver contributions accrued by the payee since the start of the current contribution period, as of the date on which the payslip was generated.

Yes

KiwiSaverAmount

Displays the total amount of employer KiwiSaver contributions accrued by the payee in the pay batch in which the payslip was generated.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No

Payslip KiwiSaver ESCT

Groups information about employer super contributions tax (ESCT) on KiwiSaver contributions on the payslip.

None

Literal header text as defined by the component label.

Yes

KiwiSaverEsctYTD

Displays the total amount of Employer Superannuation Contribution Tax payable on the employer KiwiSaver contributions the payee has accrued year-to-date, as of the date the payslip was generated.

Yes

KiwiSaverEsctPeriodTD

Displays the total amount of Employer Superannuation Contribution Tax payable on the employer KiwiSaver contributions the payee has accrued during the current contribution periods, as of the date the payslip was generated.

Yes

KiwiSaverEsct

Displays the total amount of Employer Superannuation Contribution Tax payable on the employer KiwiSaver contributions the payee has accrued in the pay batch in which the payslip was generated.

Yes

Any additional general payslip database fields.

Refer to General Payslip Fields (NZ Only) for a list of the available fields and what each field displays.

No