list_xero_pay_runs
list_xero_pay_runsThis organisation's recent pay runs - period, payment date, status (DRAFT or POSTED) and organisation-wide totals. Read-only, for Australian, New Zealand and United Kingdom organisations (this refuses plainly for any other country). Also requires Xero's own Payroll setup to be complete for the organisation, and the Xero user who connected to have held payroll administrator access at the time - if either is missing this refuses plainly rather than returning an empty list, so report that rather than implying the organisation has no payroll data. Most recent first. netPay (amount actually paid to employees) is reported by every region; Australia additionally breaks out wages/deductions/tax/super, while New Zealand and the United Kingdom instead report totalCost (the full cost to the employer, including employer-side tax/super/NI that Australia reports separately) - do not assume a field is zero just because it is absent, it may simply not be something this region's own Xero API reports at that level. Use get_xero_pay_run_summary for per-employee detail and a comparison against the previous pay run of the same calendar. Returns up to 100 pay runs for the requested page. This tool cannot say whether a POSTED pay run has actually been paid out or reported to any tax authority - Xero has no API for either, in any region.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. Omit for page 1. Most recent pay runs come first. | |
| organisation | No | The Xero organisation to use, by its display name. Only needed if this connection reaches more than one organisation - omit it when there is only one. |