Xero

Xero Payroll AU API 2.0

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

Finance & banking#openapi

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 2.0 for orgs in Australia region.

Endpoints 9

PayrollAuV2

  • GETRetrieves timesheets/Timesheets?page=5&filter=employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000&status=Draft&startDate=2019-01-02&endDate=2020-01-02&sort=startDate
  • POSTCreates a new timesheet/Timesheets
  • GETRetrieve a specific timesheet by using a unique timesheet ID/Timesheets/:TimesheetID
  • DELETEDeletes a specific timesheet/Timesheets/:TimesheetID
  • POSTCreates a new timesheet line for a specific timesheet using a unique timesheet ID/Timesheets/:TimesheetID/Lines
  • POSTApproves a specific timesheet/Timesheets/:TimesheetID/Approve
  • POSTReverts a specific timesheet to draft/Timesheets/:TimesheetID/RevertToDraft
  • PUTUpdates a specific timesheet line for a specific timesheet/Timesheets/:TimesheetID/Lines/:TimesheetLineID
  • DELETEDeletes a specific timesheet line/Timesheets/:TimesheetID/Lines/:TimesheetLineID

API details

Base URL
https://api.xero.com/payroll.xro/2.0
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
Operations
9 operations on 6 pathsPOST 4GET 2DELETE 2PUT 1
Main resources
PayrollAuV2 9
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 20.1.0

How to test the Xero Payroll AU API 2.0 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Payroll AU API 2.0 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieves timesheets” (GET /Timesheets?page=5&filter=employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000&status=Draft&startDate=2019-01-02&endDate=2020-01-02&sort=startDate), 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 2.0?

This is the Xero Payroll API 2.0 for orgs in Australia region. It is listed under Finance & banking and has 9 endpoints.

Who publishes the Xero Payroll AU API 2.0?

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 2.0?

Requests go to https://api.xero.com/payroll.xro/2.0. Endpoint paths are added to this base URL.

How do I authenticate with the Xero Payroll AU API 2.0?

With OAuth 2.0 (authorization code flow) with 2 scopes.

How many endpoints does the Xero Payroll AU API 2.0 have?

9 operations on 6 paths (4 POST, 2 GET, 2 DELETE, 1 PUT). The largest groups are PayrollAuV2.

Is forking the Xero Payroll AU API 2.0 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.