Payslip data schemas

The au.payslip.v2 schema

Set schema to au.payslip.v2 and send the payslip data in payslip_non_pii. The schema is closed to undocumented fields, but some defined fields accept printed strings. Closed does not mean free-text-free or guarantee that values contain no personal data. Your integration must keep employee PII out of every non-PII field; the API does not detect PII in accepted string values.

Conventions

• ✓ Send each field that your payslip shows.
• ✓ Send each amount, rate and quantity as a decimal string. Refer to Amounts, rates and quantities.
• ✓ Send currency on each payslip. Refer to Currency.
• ✓ Keep personal data out of every field. Send the employee name, the address and the bank details in the encrypted PII.
• ✓ Write each date as YYYY-MM-DD.

A payslip in New Zealand uses nz.payslip.v2, which has a different field list. Refer to the nz.payslip.v2 schema.

The code sets below use the ATO Single Touch Payroll Phase 2 categories.

Amounts, rates and quantities

Send each amount, rate and quantity as a JSON string that contains a plain decimal number.

An amount

"gross": "3600.00"

• ✓ Use digits and a decimal point. Put a minus sign at the start of a negative value.
• ✓ Do not send a thousands separator, currency symbol, bracket, unit, plus sign or exponent.
• ✓ Send a string, not a JSON number.
• ✓ Any number of decimal places is valid. The API stores the string as you send it. "1.50" and "1.5" are different values.
• ✓ Every field accepts a negative value, hours and quantities included.

The SDKs check the format of each number before they send the request.

From the printed payslip to the string

printed          send
$3,600.00        "3600.00"
3,600.00         "3600.00"
(123.45)         "-123.45"
NIL              "0.00"
-                "0.00"
76.00 hrs        "76"
12%              "12"
47.3684          "47.3684"

Send a nil line as zero, for example "0.00".

A rate of four decimal places, and a nil line

{
  "period_start": "2026-03-21",
  "period_end": "2026-04-03",
  "payment_date": "2026-04-04",
  "currency": "AUD",
  "gross": "3600.00",
  "paygw": "752.00",
  "net": "2848.00",
  "hourly": {
    "ordinary_rate": "47.3684",
    "hours": "76",
    "amount": "3600.00"
  },
  "earnings": [
    {
      "type": "ordinary",
      "units": "76",
      "rate": "47.3684",
      "amount": "3600.00"
    },
    {
      "type": "overtime",
      "amount": "0.00"
    }
  ]
}

Currency

Send currency on each payslip. Use the three-letter alphabetic code of the payslip currency, for example AUD or NZD. Write the code in capital letters.

The API accepts each current ISO 4217 currency code. It does not accept fund codes or codes that have no minor unit, for example XAU, XTS and XXX. SIX, the ISO 4217 maintenance agency, publishes the list on its data standards page.

The currency does not set the number of decimal places in an amount.

Common mapping mistakes

These mistakes put a correct figure in the wrong field.

1. PAYG withholding is not a deduction

Send PAYG withholding in paygw, also when the payslip prints it under “Deductions”. deductions[] is for post-tax deductions only.

A payslip that prints tax under Deductions

Gross                3,600.00
Deductions
  PAYG withholding     752.00     -> paygw: "752.00"
  Health fund           45.50     -> deductions: [{ type: "other_post_tax", amount: "45.50" }]
Net                  2,802.50

2. There are two gross figures

gross is the gross before salary sacrifice. Send the gross after salary sacrifice as taxable_gross.

Which number goes where

Gross (before sacrifice)   3,600.00   -> gross:         "3600.00"
Salary sacrifice to super    200.00   -> salary_sacrifice[].amount: "200.00"
Taxable gross (printed)    3,400.00   -> taxable_gross: "3400.00"

3. A number field takes no formatting

Send the number only. Remove the currency symbol, the separators and the unit.

Send a plain decimal string

"gross": "3600.00"       valid
"gross": "$3,600.00"     rejected: no currency symbol
"gross": "3,600.00"      rejected: no thousands separator
"gross": 3600.00         rejected: send a string

4. Free text becomes an enum

The schema has no field for a pay-code name. Map each pay code to its STP category, for example “Salary” to ordinary. If a pay code has no category, refer to Itemising earnings.

The record contains no pay-code names

"Salary"                 -> { type: "ordinary",   amount: "3040.00" }
"Time and a half"        -> { type: "overtime",   amount: "240.00" }
"Tool allowance"         -> { type: "allowance",  allowance_type: "tools", amount: "40.00" }
"Annual Leave Taken"     -> { type: "paid_leave", leave_type: "other_paid_leave", amount: "280.00" }

Validation error reference

If the API rejects a payload, it returns VALIDATION_FAILED and lists the applicable fields in field_errors. The table shows each message from the payslip schema and the usual cause of that message.

Message	Usual cause
Unrecognized key: “…”	The payload contains a field that is not in the schema. The schema is closed. Remove the field. A leave balance, a fund name and an award code each cause this message.
Invalid discriminator value. Expected ‘paid_leave’ | ‘allowance’ | …	The payload contains a pay-code name in the earnings type field. Map the pay code to one of the nine types.
must be a decimal number, for example 1234.56	An amount, rate or quantity is empty, or it contains a separator, a currency symbol, a bracket, a unit or a word. Send a plain decimal string.
Invalid input: expected string, received number	An amount, rate or quantity is a JSON number. Send it as a string.
Invalid input: expected string, received object	An amount, rate or quantity is an object. Send it as a string.
Invalid input: expected string, received undefined	A required amount is missing, for example net. Add it.
Too small: expected string to have >=1 characters	A text field, for example award, is an empty string. Send the printed text, or remove the field.
currency must be an ISO 4217 currency code	The currency field is missing, or it does not contain an accepted ISO 4217 code. Send a code such as AUD or NZD.
USI must be a fund ABN plus 3-digit product suffix (14 digits) or a SPIN	The usi field contains an 11-digit ABN. Send contributions to a self-managed fund with no fund identifier.
period_end must not be before period_start	period_end is before period_start. Examine the two dates.
other_category is required on an ‘other’ allowance	An allowance of the type other has no descriptor. Select one of the six other_category values.
other_category applies only to allowance_type ‘other’	The payload contains a descriptor on an allowance that is not of the type other.
<field> must be YYYY-MM-DD	The date is not in ISO format, or the date does not exist. The API rejects 2026-02-31 and 31/03/2026.

Core fields

Each payslip requires these fields.

Field	Type	Meaning
period_end	date	Last day of the pay period (YYYY-MM-DD). Must not be before period_start when you send it.
payment_date	date	The day the employee is paid.
currency	string	The ISO 4217 code of the payslip currency, for example AUD. Refer to Currency.
gross	decimal string	Total gross before salary sacrifice, as Single Touch Payroll Phase 2 reports it.
paygw	decimal string	PAYG withholding. Its own field, never also a deductions line.
net	decimal string	Net pay, as shown on the payslip.

A payload that contains only the core fields is valid. Use it only for a payslip that shows no other data.

A minimal payslip_non_pii

{
  "period_end": "2026-04-03",
  "payment_date": "2026-04-04",
  "currency": "AUD",
  "gross": "3600.00",
  "paygw": "752.00",
  "net": "2848.00"
}

Other fields

Send each of these fields that your payslip shows.

Field	Type	Meaning
period_start	date	First day of the pay period (YYYY-MM-DD).
ytd_gross	decimal string	Year-to-date gross across the financial year, including this pay run.
ytd_paygw	decimal string	Year-to-date PAYG withholding, including this pay run.
pay_frequency	enum	One of weekly, fortnightly, monthly or quarterly.
employment_basis	enum	STP2 employment basis. Independent of engagement_type.
engagement_type	enum	One of permanent or fixed_term. A Fair Work notion with no STP2 counterpart.
award	string	The award or agreement line as your payslip prints it.
hourly	object	The ordinary rate, hours and amount. Send this object when the employee is paid hourly.
annual_rate	decimal string	The annual rate, when the employee is paid one.
taxable_gross	decimal string	The post-sacrifice taxable gross.
stsl_withholding	decimal string	The HELP/STSL component printed on the payslip. Already inside paygw.
earnings	array	Itemisation of gross.
salary_sacrifice	array	Salary sacrifice lines. Each line has a type and an amount, and can have a year-to-date amount.
deductions	array	Post-tax deduction lines. Each line has a type and an amount, and can have a year-to-date amount.
superannuation	array	Superannuation contribution lines. Each line has a contribution type and amount. It can also have a rate, year-to-date amount and USI.
reimbursements	decimal string	Non-taxable reimbursements. Not part of gross.
ytd	object	Further year-to-date totals: taxable, super, non_taxable, post_tax_deductions, reimbursements.

The award field

Send the award or agreement line as the payslip prints it, with the classification, as one string.

Examples of a printed award line

"Clerks - Private Sector Award 2020 Level 3"
"Manufacturing and Associated Industries Award 2020 C10"
"Acme Pty Ltd Enterprise Agreement 2024"
"Award free"

Keep personal data out of this field. An agreement title contains the name of the employer. It must not contain the name of the employee.

Code sets

Map your existing Single Touch Payroll Phase 2 categories to the accepted values below. PAYG withholding has its own field. deductions[] contains post-tax deductions only.

Earnings line types

Each earnings[] line has a type and an amount. A line can also contain units, rate and ytd_amount. Two types have an additional code. A line cannot contain the additional code of the other type.

Send the number without the unit, for example "76" for 76.00 hrs. The schema has no unit field.

type	Meaning
ordinary	Ordinary hours.
overtime	Overtime.
bonus_commission	Bonuses and commissions.
directors_fees	Directors’ fees.
lump_sum	Lump sums, including termination pay.
return_to_work	Return-to-work payments.
other	A pay code that has no other type. Use it only when no other type is correct.
paid_leave	Paid absence. Carries a leave_type from the leave set below.
allowance	Allowance. Carries an allowance_type from the allowance set below.

Paid leave

Use these values in leave_type on a paid_leave line.

leave_type	STP2 code	Meaning
cash_out_in_service	C	Leave cashed out while still employed.
unused_on_termination	U	Unused leave paid out on termination.
paid_parental	P	Paid parental leave.
workers_compensation	W	Absence paid under workers compensation.
ancillary_defence	A	Ancillary and defence leave.
other_paid_leave	O	The ATO general code: annual, personal, long service, RDO, TOIL, and each other paid absence.

ATO reference: STP Phase 2 reporting quick reference guide

Allowances

Use these values in allowance_type on an allowance line.

allowance_type	STP2 code	Meaning
cents_per_km	CD	Cents-per-kilometre allowance.
award_transport	AD	Award transport payments.
laundry	LD	Laundry allowance.
overtime_meal	MD	Overtime meal allowance.
travel	RD	Travel allowance.
tools	TD	Tools allowance.
tasks	KN	Task allowance.
qualifications	QN	Qualification allowance.
other	OD	This type requires other_category. No other type accepts other_category.

Send other_category on each allowance of the type other. Use a value below. The API rejects other_category on other allowance types.

other_category	STP2 code	Meaning
home_office	H1	Home office costs.
non_deductible	ND	Non-deductible amounts.
transport_fares	T1	Transport fares.
uniform	U1	Uniform costs.
private_vehicle	V1	Private vehicle use.
general	G1	The general descriptor.

ATO reference: Allowances

An 'other' allowance line

{
  "type": "allowance",
  "allowance_type": "other",
  "other_category": "home_office",
  "amount": "80.00"
}

Deductions

These types are for post-tax deductions only. PAYG withholding is not a deduction.

type	STP2 code	Meaning
union_professional_fees	F	Union and professional association fees.
workplace_giving	W	Workplace giving.
child_support_deduction	D	Child support deduction.
child_support_garnishee	G	Child support garnishee.
other_post_tax		Any other post-tax deduction, for example a health fund or a social club.

ATO reference: Other components of your STP reporting

Salary sacrifice

The type field accepts super or other.

Superannuation contributions

These types are for employer contributions only. Send a post-tax contribution from the employee as a deduction (other_post_tax), and not as a superannuation line.

contribution_type	Meaning
superannuation_guarantee	Superannuation guarantee contributions.
resc	Reportable employer superannuation contributions.
salary_sacrifice	Sacrificed superannuation contributions.

Employment basis

Send engagement_type (permanent or fixed_term) in its own field.

employment_basis	STP2 code
full_time	F
part_time	P
casual	C
labour_hire	L
voluntary_agreement	V
death_beneficiary	D
non_employee	N

ATO reference: How to report employment and tax information

Pay frequency

The pay_frequency field accepts weekly, fortnightly, monthly or quarterly.

Itemising earnings

Send an earnings line for each pay code on the payslip. The lines itemise gross. They do not add to it.

Send all of the earnings lines, or none of them. The record cannot show that a line is missing.

If a pay code has no category, send it as a line of the type other. Use other only when no other type is correct.

Use the standard code sets for termination pay. There are no ETP or lump-sum sub-codes:

The earnings on a termination payslip

[
  {
    "type": "ordinary",
    "amount": "3000.00"
  },
  {
    "type": "paid_leave",
    "leave_type": "unused_on_termination",
    "amount": "4000.00"
  },
  {
    "type": "lump_sum",
    "amount": "5000.00"
  }
]

Identifying a superannuation fund

A superannuation line can contain usi, or no identifier. The schema has no field for a fund ABN and no field for a fund name.

• ✓ usi is an APRA-product Unique Superannuation Identifier: the fund ABN with a 3-digit product suffix (14 digits), or a SPIN such as STA0100AU. It does not accept an 11-digit ABN.
• ✓ A 14-digit usi starts with the fund ABN, so the schema has no separate fund_abn field. A record that contains one is rejected.
• ✓ A self-managed fund has no USI. Send its contributions with no fund identifier.

Year-to-date figures

Send each year-to-date figure that your payslip shows. There are three places for a year-to-date figure:

• ✓ ytd_gross and ytd_paygw hold the two principal totals.
• ✓ ytd_amount on an earnings, salary_sacrifice, deductions or superannuation line holds the figure for that line.
• ✓ The ytd object holds the further totals: taxable, super, non_taxable, post_tax_deductions and reimbursements.

Each year-to-date figure includes the pay run that you register.

What the schema does not carry

The schema does not contain these fields. The API rejects them. Remove them from your payload.

Not in the schema	Why
Leave balances	The schema has no leave-balance field.
Super fund names	Identify a fund with a usi, or send no identifier.
Employee names, addresses and bank details	Send personal data in the encrypted PII payload.
Award codes and classification levels	Send the printed line as award.
Income stream types, tax treatment codes	The schema has no field for these.
ETP and lump-sum sub-codes	Send termination pay as a lump_sum line.

Complete example

This fortnightly payslip shows hourly pay, an allowance, paid leave, salary sacrifice to superannuation, a post-tax deduction and a reimbursement.

payslip_non_pii

{
  "period_start": "2026-03-21",
  "period_end": "2026-04-03",
  "payment_date": "2026-04-04",
  "currency": "AUD",
  "pay_frequency": "fortnightly",
  "gross": "3600.00",
  "taxable_gross": "3400.00",
  "paygw": "752.00",
  "net": "2682.50",
  "ytd_gross": "43200.00",
  "ytd_paygw": "9024.00",
  "earnings": [
    {
      "type": "ordinary",
      "units": "76",
      "rate": "40.00",
      "amount": "3040.00",
      "ytd_amount": "36480.00"
    },
    {
      "type": "overtime",
      "units": "4",
      "rate": "60.00",
      "amount": "240.00"
    },
    {
      "type": "allowance",
      "allowance_type": "tools",
      "amount": "40.00"
    },
    {
      "type": "paid_leave",
      "leave_type": "other_paid_leave",
      "amount": "280.00"
    }
  ],
  "salary_sacrifice": [
    {
      "type": "super",
      "amount": "200.00"
    }
  ],
  "deductions": [
    {
      "type": "other_post_tax",
      "amount": "45.50"
    }
  ],
  "superannuation": [
    {
      "contribution_type": "superannuation_guarantee",
      "amount": "398.40",
      "rate": "12",
      "usi": "STA0100AU"
    },
    {
      "contribution_type": "salary_sacrifice",
      "amount": "200.00"
    }
  ],
  "reimbursements": "80.00",
  "employment_basis": "full_time",
  "engagement_type": "permanent",
  "award": "Clerks - Private Sector Award 2020 Level 3",
  "stsl_withholding": "120.00",
  "hourly": {
    "ordinary_rate": "40.00",
    "hours": "76",
    "amount": "3040.00"
  },
  "annual_rate": "93600.00",
  "ytd": {
    "taxable": "40800.00",
    "super": "4780.80",
    "non_taxable": "960.00",
    "post_tax_deductions": "546.00",
    "reimbursements": "960.00"
  }
}

Versioning

au.payslip.v2 will not change. A new field or a changed field gives a new schema id, au.payslip.v3. Records that you register with v2 stay valid, and a lender can still verify them.

The API also accepts au.payslip.v1 and nz.payslip.v1. v1 uses integer minor units and a different field list. If you send v1 today, refer to Migrate to the v2 payslip schemas.

The single registration endpoints accept each supported schema id. The schema field selects which schema applies to your payload. Batch registration examines the schema id of each record. An unsupported version fails that record only, and not the full batch.

The nz.payslip.v2 schema

Set schema to nz.payslip.v2 and send the payslip data in payslip_non_pii. The schema is closed to undocumented fields, but accepts printed strings. Your integration must keep employee PII out of every non-PII field; the API does not detect PII in accepted string values. Put identifying information in the encrypted PII payload instead.

Conventions

• ✓ Send each field that your payslip shows.
• ✓ Send each amount, rate and quantity as a decimal string. Refer to Amounts, rates and quantities.
• ✓ Send currency on each payslip. Refer to Currency.
• ✓ Send tax_code, pay_cycle and employment_type as printed text. Send what the payslip shows. Do not map these values to a code set.
• ✓ Write each date as YYYY-MM-DD.

The earnings, allowance and deduction code sets below use the Inland Revenue Employment Information categories.

Source: Inland Revenue, Payday filing

Common mapping mistakes

These mistakes put a correct figure in the wrong field.

1. Family violence leave is ordinary pay

Do not map paid family violence leave to a leave type. The schema has no code for it, and you must not put it in other_paid_leave. Include the amount in ordinary pay.

A payslip with paid family violence leave

Ordinary hours       2,400.00
Family violence        600.00     -> earnings: [{ type: "ordinary", amount: "3000.00" }]
Gross                3,000.00        (one ordinary line of 3,000.00, with no leave line)

2. Each statutory deduction has its own field

PAYE, student loan, child support, KiwiSaver and ESCT each have their own field. deductions[] holds the other post-tax deductions.

A payslip that prints everything under Deductions

Gross                3,000.00
Deductions
  PAYE                   660.00   -> paye: "660.00"
  Student loan           100.00   -> student_loan: "100.00"
  KiwiSaver 3.5%         105.00   -> kiwisaver_employee_deduction: "105.00"
  Child support           50.00   -> child_support: "50.00"
  Health fund             35.00   -> deductions: [{ type: "other_post_tax", amount: "35.00" }]
Net                  2,050.00

Send paye on every payslip. Send "0.00" when the pay has no PAYE.

3. An employee share scheme benefit has its own field

Send it as employee_share_scheme, and not in gross or an earnings line.

4. A KiwiSaver rate is the printed rate

Send the rate as a decimal string without the percent sign, for example "3.5" for 3.5%.

Source: Inland Revenue, KiwiSaver for employers

Core fields

Each registration must contain these six fields.

Field	Type	Meaning
period_end	date	Last day of the pay period (YYYY-MM-DD). Must not be before period_start when you send it.
payment_date	date	The day that you pay the employee.
currency	string	The ISO 4217 code of the payslip currency, for example NZD. Refer to Currency.
gross	decimal string	Taxable gross earnings and schedular payments. Does not include an employee share scheme benefit.
paye	decimal string	PAYE, or tax on schedular payments. Its own field, never also a deductions line.
net	decimal string	Net pay, as shown on the payslip.

The minimum payload

{
  "period_end": "2026-04-19",
  "payment_date": "2026-04-22",
  "currency": "NZD",
  "gross": "3000.00",
  "paye": "660.00",
  "net": "2135.00"
}

Other fields

Send each of these fields that your payslip shows.

Field	Type	Meaning
period_start	date	First day of the pay period (YYYY-MM-DD).
ytd_gross	decimal string	Year-to-date gross, including this pay run.
ytd_paye	decimal string	Year-to-date PAYE, including this pay run.
pay_cycle	string	The pay cycle as your payslip prints it.
tax_code	string	The tax code as your payslip prints it.
employment_type	string	The employment type as your payslip prints it.
hours_paid	decimal string	The hours that you paid the employee for this paydate.
hourly	object	The ordinary rate, hours and amount. Send this object when you pay an hourly rate.
annual_rate	decimal string	The annual rate, when you pay a salary.
earnings_not_liable_for_acc	decimal string	Earnings that the ACC earners’ levy does not apply to.
earnings	array	Itemisation of gross. See the code sets below.
employee_share_scheme	decimal string	An employee share scheme benefit. Not part of gross.
prior_period_gross_adjustment	decimal string	A correction to the gross of a prior period.
prior_period_paye_adjustment	decimal string	A correction to the PAYE of a prior period.
payroll_donation_tax_credit	decimal string	The payroll donation tax credit.
student_loan	decimal string	Standard student loan repayment.
slcir	decimal string	Student loan deduction that the Commissioner directs.
slbor	decimal string	Extra student loan deduction that the borrower asks for.
child_support	decimal string	Child support deduction.
kiwisaver_employee_deduction	decimal string	The KiwiSaver deduction from the employee.
kiwisaver_employee_rate	decimal string	The employee contribution rate, as the payslip prints it.
kiwisaver_employer_contribution	decimal string	The net employer contribution, exclusive of ESCT.
esct	decimal string	Employer superannuation contribution tax.
deductions	array	Post-tax deduction lines. Each line has a type and an amount, and can have a year-to-date amount.
reimbursements	decimal string	Non-taxable reimbursing payments. Not part of gross.
leave_balances	object	The leave entitlement of the employee. Each balance has an amount and a unit.
ytd	object	Other year-to-date totals. See the field list below.

Code sets

tax_code, pay_cycle and employment_type have no code set. Send the text that your payslip prints.

earnings[].type

Value	Meaning
ordinary	Ordinary pay.
overtime
penal_rate
piece_work
bonus_commission
extra_pay	An Inland Revenue lump sum (extra pay).
schedular_payment	A schedular payment.
directors_fees
pay_as_you_go_holiday_pay	The 8% holiday pay that you pay with each pay. Not leave that the employee takes.
leave_compensation_payment	The Employment Leave Act 2026 replacement for the 8%.
annual_holiday_cash_out	Annual holiday that the employee cashes up.
alternative_holiday_cash_out
holiday_pay_on_termination	Holiday pay that you pay when employment ends.
other	A pay code that has no other type. Use it only when no other type is correct.
paid_leave	Leave that the employee takes. Carries a leave_type.
allowance	A taxable allowance. Carries an allowance_type.

Send the number without the unit, for example "76" for 76.00 hrs. The schema has no unit field.

earnings[].leave_type

For leave that the employee takes. There is no family violence code. See the mapping mistakes above. A public holiday uses public_holiday, whether or not the employee worked it. A day in lieu shows in leave_balances.alternative.

Value	Meaning
annual_holiday	Annual holiday that the employee takes.
public_holiday
alternative_holiday
sick_leave
bereavement_leave
other_paid_leave	Each other kind of paid leave that the employee takes.

earnings[].allowance_type

For a taxable allowance. A non-taxable reimbursing payment goes in reimbursements.

Value	Meaning
meal
travel
accommodation
vehicle
phone
tools
uniform
on_call
shift
first_aid
higher_duties
qualification
other	Each other taxable allowance.

deductions[].type

Value	Meaning
union_fees
payroll_donation	The donation. The tax credit has its own field.
attachment_order	A District Court attachment order.
ir_arrears	An Inland Revenue arrears deduction notice.
other_post_tax	Each other post-tax deduction, for example a health fund.

Leave balances

leave_balances holds leave entitlement, and not pay. Each balance has an amount and a unit. Send the unit that the payslip prints.

leave_balances

{
  "annual": { "amount": "4", "unit": "weeks" },
  "annual_accrued_this_period": { "amount": "6.15", "unit": "hours" },
  "sick": { "amount": "10", "unit": "days" },
  "alternative": { "amount": "8", "unit": "hours" }
}

The unit can be hours, days or weeks. There is no family violence balance.

Year-to-date totals

Send each year-to-date total that your payslip shows. ytd_gross and ytd_paye hold the principal totals. The ytd object holds the totals below. ytd_amount on a deductions line holds the total for that line.

Field	Type	Meaning
student_loan	decimal string	Year-to-date student loan repayments.
kiwisaver_employee	decimal string	Year-to-date KiwiSaver employee deductions.
kiwisaver_employer	decimal string	Year-to-date net KiwiSaver employer contributions, exclusive of ESCT.
child_support	decimal string	Year-to-date child support deductions.
non_taxable	decimal string	Year-to-date non-taxable payments.
post_tax_deductions	decimal string	Year-to-date post-tax deductions.
reimbursements	decimal string	Year-to-date reimbursing payments.

Each total includes the pay run that you register.

What is not carried

• Personal data. Send the name, the IRD number, the address and the bank details in the encrypted PII.
• Paid family violence leave, in each form. There is no leave code, and no balance.
• A KiwiSaver scheme identifier. There is no field for one.
• The child support variation code. The deduction carries its amount only.

Complete examples

A salaried employee who is paid each two weeks, with KiwiSaver and a student loan.

Salaried, fortnightly

{
  "period_start": "2026-04-06",
  "period_end": "2026-04-19",
  "payment_date": "2026-04-22",
  "currency": "NZD",
  "pay_cycle": "Fortnightly",
  "tax_code": "M SL",
  "employment_type": "Permanent",
  "hours_paid": "80",
  "gross": "3000.00",
  "paye": "660.00",
  "net": "2135.00",
  "ytd_gross": "3000.00",
  "ytd_paye": "660.00",
  "earnings": [
    {
      "type": "ordinary",
      "units": "76",
      "rate": "37.50",
      "amount": "2850.00"
    },
    {
      "type": "overtime",
      "units": "4",
      "rate": "37.50",
      "amount": "150.00"
    }
  ],
  "student_loan": "100.00",
  "kiwisaver_employee_deduction": "105.00",
  "kiwisaver_employee_rate": "3.5",
  "kiwisaver_employer_contribution": "105.00",
  "esct": "18.37",
  "leave_balances": {
    "annual": {
      "amount": "4",
      "unit": "weeks"
    },
    "sick": {
      "amount": "10",
      "unit": "days"
    }
  }
}

A casual employee who gets 8% holiday pay with each pay. The 8% is an earnings line, and not leave.

Casual, with pay-as-you-go holiday pay

{
  "period_start": "2026-04-06",
  "period_end": "2026-04-19",
  "payment_date": "2026-04-22",
  "currency": "NZD",
  "pay_cycle": "Ad hoc",
  "tax_code": "M",
  "employment_type": "Casual",
  "hours_paid": "32",
  "gross": "1036.80",
  "paye": "186.62",
  "net": "850.18",
  "earnings": [
    {
      "type": "ordinary",
      "units": "32",
      "rate": "30.00",
      "amount": "960.00"
    },
    {
      "type": "pay_as_you_go_holiday_pay",
      "amount": "76.80"
    }
  ]
}