Xero Payroll AU API
This is the Xero Payroll API for orgs in Australia region.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the Xero Payroll API for orgs in Australia region.
Endpoints 32
PayrollAu
- GETSearches payroll employees
/Employees?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a payroll employee
/Employees - GETRetrieves an employee's detail by unique employee id
/Employees/:EmployeeID - POSTUpdates an employee's detail
/Employees/:EmployeeIDUpdate properties on a single employee - GETRetrieves leave applications
/LeaveApplications?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a leave application
/LeaveApplications - GETRetrieves leave applications including leave requests
/LeaveApplications/v2?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - GETRetrieves a leave application by a unique leave application id
/LeaveApplications/:LeaveApplicationID - POSTUpdates a specific leave application
/LeaveApplications/:LeaveApplicationID - POSTApprove a requested leave application by a unique leave application id
/LeaveApplications/:LeaveApplicationID/approve - POSTReject a leave application by a unique leave application id
/LeaveApplications/:LeaveApplicationID/reject - GETRetrieves pay items
/PayItems?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a pay item
/PayItems - GETRetrieves payroll calendars
/PayrollCalendars?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a Payroll Calendar
/PayrollCalendars - GETRetrieves payroll calendar by using a unique payroll calendar ID
/PayrollCalendars/:PayrollCalendarID - GETRetrieves pay runs
/PayRuns?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a pay run
/PayRuns - GETRetrieves a pay run by using a unique pay run id
/PayRuns/:PayRunID - POSTUpdates a pay run
/PayRuns/:PayRunIDUpdate properties on a single PayRun - GETRetrieves for a payslip by a unique payslip id
/Payslip/:PayslipID - POSTUpdates a payslip
/Payslip/:PayslipIDUpdate lines on a single payslips - GETRetrieves payroll settings
/Settings - GETRetrieves superfunds
/Superfunds?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a superfund
/Superfunds - GETRetrieves a superfund by using a unique superfund ID
/Superfunds/:SuperFundID - POSTUpdates a superfund
/Superfunds/:SuperFundIDUpdate properties on a single Superfund - GETRetrieves superfund products
/SuperfundProducts?ABN=40022701955&USI=OSF0001AU - GETRetrieves timesheets
/Timesheets?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0 - POSTCreates a timesheet
/Timesheets - GETRetrieves a timesheet by using a unique timesheet id
/Timesheets/:TimesheetID - POSTUpdates a timesheet
/Timesheets/:TimesheetIDUpdate properties on a single timesheet
API details
- Base URL
https://api.xero.com/payroll.xro/1.0- Authentication
- OAuth 2.0 (authorization code flow) with 13 scopes
- Operations
- 32 operations on 19 pathsGET 17POST 15
- Main resources
- PayrollAu 32
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
20.1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Xero's published OpenAPI description (XeroAPI/Xero-OpenAPI) (MIT)
How to test the Xero Payroll AU API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Payroll AU API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 13 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Searches payroll employees” (GET /Employees?where=Status=="ACTIVE"&order=EmailAddress%20DESC&page=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Xero Payroll AU API?
This is the Xero Payroll API for orgs in Australia region. It is listed under Finance & banking and has 32 endpoints.
Who publishes the Xero Payroll AU API?
It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Xero Payroll AU API?
Requests go to https://api.xero.com/payroll.xro/1.0. Endpoint paths are added to this base URL.
How do I authenticate with the Xero Payroll AU API?
With OAuth 2.0 (authorization code flow) with 13 scopes.
How many endpoints does the Xero Payroll AU API have?
32 operations on 19 paths (17 GET, 15 POST). The largest groups are PayrollAu.
Is forking the Xero Payroll AU API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.