Xero.Payroll.NZ (Xero v1.0.0)

Xero Payroll API – New Zealand. Base URL: https://api.xero.com/payrollnz.xro/1.0/ Scopes: payroll.employees, payroll.payruns, payroll.payslip, payroll.settings Covers NZ payroll including PAYE, KiwiSaver, and NZ leave entitlements.

Summary

Functions

approve_timesheet(t, tid, id)

create_deduction_type(t, tid, attrs)

create_earnings_rate(t, tid, attrs)

create_employee(t, tid, attrs)

create_employee_leave(t, tid, id, attrs)

Creates leave for an employee.

create_leave_type(t, tid, attrs)

create_pay_run(t, tid, attrs)

Creates a new pay run from a pay run calendar.

create_pay_run_calendar(t, tid, attrs)

create_reimbursement(t, tid, attrs)

create_statutory_leave(t, tid, attrs)

Creates a statutory leave record (e.g. parental leave).

create_timesheet(t, tid, attrs)

delete_employee_leave(t, tid, id, leave_id)

Deletes leave for an employee.

delete_pay_run(t, tid, id)

Deletes a DRAFT pay run.

get_deduction_type(t, tid, id)

get_earnings_rate(t, tid, id)

get_employee(t, tid, id)

get_employee_leave(t, tid, id, opts \\ [])

Returns leave for an employee.

get_employee_leave_balances(t, tid, id)

Returns leave balances for an employee.

get_employee_tax(t, tid, id)

Returns tax settings for a NZ employee.

get_leave_type(t, tid, id)

get_pay_run(t, tid, id)

get_pay_run_calendar(t, tid, id)

get_payslip(t, tid, id)

get_reimbursement(t, tid, id)

get_statutory_leave_periods(t, tid, statutory_leave_id)

Returns statutory leave periods for an employee.

get_timesheet(t, tid, id)

list_deduction_types(t, tid, opts \\ [])

list_earnings_rates(t, tid, opts \\ [])

list_employees(t, tid, opts \\ [])

list_leave_types(t, tid, opts \\ [])

list_pay_run_calendar(t, tid, opts \\ [])

list_pay_runs(t, tid, opts \\ [])

list_reimbursements(t, tid, opts \\ [])

list_timesheets(t, tid, opts \\ [])

post_pay_run(t, tid, id)

Posts (finalises) a pay run.

revert_pay_run(t, tid, id)

Reverts a posted pay run back to DRAFT.

revert_timesheet(t, tid, id)

settings(t, tid)

statutory_leave_summary(t, tid, employee_id, opts \\ [])

update_deduction_type(t, tid, id, attrs)

update_earnings_rate(t, tid, id, attrs)

update_employee(t, tid, id, attrs)

update_employee_leave(t, tid, id, leave_id, attrs)

Updates leave for an employee.

update_employee_tax(t, tid, id, attrs)

update_leave_type(t, tid, id, attrs)

update_pay_run(t, tid, id, attrs)

Updates a pay run (e.g. to set payment date).

update_payslip(t, tid, id, attrs)

update_reimbursement(t, tid, id, attrs)