Xero Payroll AU API API

by xero.com

Overview

This is the Xero Payroll API for orgs in Australia region.

Xero Payroll AU API is a finance API from xero.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 29 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://api.xero.com/payroll.xro/1.0
Version: 2.9.4
Endpoints: 29
OpenAPI: Specification ↗
Spec updated: 2021-02-25

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.xero.com/payroll.xro/1.0/Employees" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.xero.com/payroll.xro/1.0/Employees", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.xero.com/payroll.xro/1.0/Employees",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/Employees`	Searches payroll employees
POST	`/Employees`	Creates a payroll employee
GET	`/Employees/{EmployeeID}`	Retrieves an employee's detail by unique employee id
POST	`/Employees/{EmployeeID}`	Updates an employee's detail
GET	`/LeaveApplications`	Retrieves leave applications
POST	`/LeaveApplications`	Creates a leave application
GET	`/LeaveApplications/{LeaveApplicationID}`	Retrieves a leave application by a unique leave application id
POST	`/LeaveApplications/{LeaveApplicationID}`	Updates a specific leave application
GET	`/PayItems`	Retrieves pay items
POST	`/PayItems`	Creates a pay item
GET	`/PayRuns`	Retrieves pay runs
POST	`/PayRuns`	Creates a pay run
GET	`/PayRuns/{PayRunID}`	Retrieves a pay run by using a unique pay run id
POST	`/PayRuns/{PayRunID}`	Updates a pay run
GET	`/PayrollCalendars`	Retrieves payroll calendars
POST	`/PayrollCalendars`	Creates a Payroll Calendar
GET	`/PayrollCalendars/{PayrollCalendarID}`	Retrieves payroll calendar by using a unique payroll calendar ID
GET	`/Payslip/{PayslipID}`	Retrieves for a payslip by a unique payslip id
POST	`/Payslip/{PayslipID}`	Updates a payslip
GET	`/Settings`	Retrieves payroll settings
GET	`/SuperfundProducts`	Retrieves superfund products
GET	`/Superfunds`	Retrieves superfunds
POST	`/Superfunds`	Creates a superfund
GET	`/Superfunds/{SuperFundID}`	Retrieves a superfund by using a unique superfund ID
POST	`/Superfunds/{SuperFundID}`	Updates a superfund
GET	`/Timesheets`	Retrieves timesheets
POST	`/Timesheets`	Creates a timesheet
GET	`/Timesheets/{TimesheetID}`	Retrieves a timesheet by using a unique timesheet id
POST	`/Timesheets/{TimesheetID}`	Updates a timesheet