Xero Xero Payroll Au
Xero Payroll AU is Xero's Australian payroll service for managing employees, pay runs, leave, timesheets, and payroll reporting.
- Base URL:
https://api.xero.com/payroll.xro/1.0 - Auth: OAuth 2.0 (user-delegated) — attach an InTouch
oauthcredential. Mint one withitcli.py /oauth <provider>(device-code) or/google-auth(Google); the server auto-refreshes the access token before each run, so the connector never handles or stores tokens.
Operations
getemployees— GET /Employees — Searches payroll employeesgetemployee— GET /Employees/{EmployeeID} — Retrieves an employee's detail by unique employee idgetleaveapplications— GET /LeaveApplications — Retrieves leave applicationsgetleaveapplication— GET /LeaveApplications/{LeaveApplicationID} — Retrieves a leave application by a unique leave application idgetpayitems— GET /PayItems — Retrieves pay itemsgetpayruns— GET /PayRuns — Retrieves pay runs
Inputs
- a linked
oauthcredential (no key inputs) — the server injects a freshAuthorization: Bearerfrom it operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getemployees
# (attach an 'oauth' credential to the task — no inline secrets)
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
operation |
string | yes | — | One of: getemployees, getemployee, getleaveapplications, getleaveapplication, getpayitems, getpayruns |
EmployeeID |
string | no | — | Path parameter EmployeeID (required by some operations). |
LeaveApplicationID |
string | no | — | Path parameter LeaveApplicationID (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |