Xero

Xero PayrollNz API

The PayrollNz API from Xero — 46 operation(s) for payrollnz.

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 71

GET /Employees Retrieves employees #
POST /Employees Creates an employees #
GET /Employees/{EmployeeID} Retrieves an employees using a unique employee ID #
PUT /Employees/{EmployeeID} Updates an existing employee #
POST /Employees/{EmployeeID}/Employment Creates an employment detail for a specific employee #
GET /Employees/{EmployeeID}/Tax Retrieves tax records for a specific employee #
POST /Employees/{EmployeeID}/Tax Updates the tax records for a specific employee #
GET /Employees/{EmployeeID}/OpeningBalances Retrieves the opening balance for a specific employee #
POST /Employees/{EmployeeID}/OpeningBalances Creates opening balances for a specific employee #
GET /Employees/{EmployeeID}/Leave Retrieves leave records for a specific employee #
POST /Employees/{EmployeeID}/Leave Creates leave records for a specific employee #
PUT /Employees/{EmployeeID}/Leave/{LeaveID} Updates leave records for a specific employee #
DELETE /Employees/{EmployeeID}/Leave/{LeaveID} Deletes a leave record for a specific employee #
GET /Employees/{EmployeeID}/LeaveBalances Retrieves leave balances for a specific employee #
GET /Employees/{EmployeeID}/LeavePeriods Retrieves leave periods for a specific employee #
POST /Employees/{EmployeeID}/LeaveSetup Creates a leave set-up for a specific employee. #
GET /Employees/{EmployeeID}/LeaveTypes Retrieves leave types for a specific employee #
POST /Employees/{EmployeeID}/LeaveTypes Creates leave type records for a specific employee #
GET /Employees/{EmployeeID}/PaymentMethods Retrieves available payment methods for a specific employee #
POST /Employees/{EmployeeID}/PaymentMethods Creates a payment method for an employee #
GET /Employees/{EmployeeID}/PayTemplates Retrieves pay templates for a specific employee #
POST /Employees/{EmployeeID}/PayTemplates/Earnings Creates earnings template records for an employee #
PUT /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} Updates an earnings template records for an employee #
DELETE /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} Deletes an employee's earnings template record #
POST /Employees/{EmployeeID}/PayTemplateEarnings Creates multiple employee earnings template records for a specific employee #
GET /Deductions Retrieves deductions for a specific employee #
POST /Deductions Creates a new deduction for a specific employee #
GET /Deductions/{deductionId} Retrieves a single deduction by using a unique deduction ID #
GET /StatutoryDeductions Retrieves statutory deductions #
GET /StatutoryDeductions/{id} Retrieves a specific statutory deduction by using a unique statutory deductions… #
GET /Superannuations Retrieves superannuations #
POST /Superannuations Creates a new superannuation #
GET /Superannuations/{SuperannuationID} Retrieves a specific superannuation using a unique superannuation ID #
GET /EarningsRates Retrieves earnings rates #
POST /EarningsRates Creates a new earnings rate #
GET /EarningsRates/{EarningsRateID} Retrieves a specific earnings rates by using a unique earnings rate id #
GET /LeaveTypes Retrieves leave types #
POST /LeaveTypes Creates a new leave type #
GET /LeaveTypes/{LeaveTypeID} Retrieves a specific leave type by using a unique leave type ID #
GET /Reimbursements Retrieves reimbursements #
POST /Reimbursements Creates a new reimbursement #
GET /Reimbursements/{ReimbursementID} Retrieves a specific reimbursement by using a unique reimbursement ID #
GET /Timesheets Retrieves timesheets #
POST /Timesheets Creates a new timesheet #
GET /Timesheets/{TimesheetID} Retrieves a specific timesheet by using a unique timesheet ID #
DELETE /Timesheets/{TimesheetID} Deletes a timesheet #
POST /Timesheets/{TimesheetID}/Lines Create a new timesheet line for a specific time sheet #
POST /Timesheets/{TimesheetID}/Approve Approves a timesheet #
POST /Timesheets/{TimesheetID}/RevertToDraft Reverts a timesheet to draft #
PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} Updates a timesheet line for a specific timesheet #
DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} Deletes a timesheet line for a specific timesheet #
GET /PayRunCalendars Retrieves payrun calendars #
POST /PayRunCalendars Creates a new payrun calendar #
GET /PayRunCalendars/{PayrollCalendarID} Retrieves a specific payrun calendar by using a unique payroll calendar ID #
GET /Employees/{EmployeeID}/SalaryAndWages Retrieves an employee's salary and wages #
POST /Employees/{EmployeeID}/SalaryAndWages Creates an employee salary and wage record #
GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Retrieves an employee's salary and wages record by using a unique salary and… #
PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Updates an employee's salary and wages record #
DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Deletes an employee's salary and wages record #
GET /PayRuns Retrieves pay runs #
POST /PayRuns Creates a pay run #
GET /PayRuns/{PayRunID} Retrieves a specific pay run by using a unique pay run ID #
GET /PaySlips Retrieves payslips #
GET /PaySlips/{PaySlipID} Retrieves a specific payslip by a unique pay slip ID #
PUT /PaySlips/{PaySlipID} Creates an employee pay slip #
GET /Settings Retrieves settings #
GET /Settings/TrackingCategories Retrieves tracking categories #
GET /Employees/{EmployeeID}/Working-Patterns Retrieves employee's working patterns #
POST /Employees/{EmployeeID}/Working-Patterns Creates an employee working pattern #
GET /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} Retrieves employee's working patterns #
DELETE /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} deletes employee's working patterns #

Documentation

📖
Documentation
https://developer.xero.com/documentation/api/accounting/overview
📖
Documentation
https://developer.xero.com/documentation/api/assets/overview
📖
Documentation
https://developer.xero.com/documentation/api/bank-feeds/overview
📖
Documentation
https://developer.xero.com/documentation/api/finance/overview
📖
Documentation
https://developer.xero.com/documentation/guides/oauth2/overview/
📖
Documentation
https://developer.xero.com/documentation/api/payroll-au/overview
📖
Documentation
https://developer.xero.com/documentation/api/payroll-nz/overview
📖
Documentation
https://developer.xero.com/documentation/api/payroll-uk/overview
📖
Documentation
https://developer.xero.com/documentation/api/projects/overview
📖
Documentation
https://developer.xero.com/documentation/api/files/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/xero/refs/heads/main/openapi/xero-payrollnz-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/xero/refs/heads/main/asyncapi/xero-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/xero:xero-payrollnz-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xero-payrollnz-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 12.0.2
  title: Xero Payroll Nz API
  description: This is the Xero Payroll API for orgs in the NZ region.
  termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
  contact:
    name: Xero Platform Team
    email: api@xero.com
    url: https://developer.xero.com
servers:
- description: Xero Payroll NZ API
  url: https://api.xero.com/payroll.xro/2.0
tags:


# --- truncated at 32 KB (276 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xero/refs/heads/main/openapi/xero-payrollnz-api-openapi.yml