list_xero_payroll_employees
list_xero_payroll_employeesThis organisation's payroll employees - name, employment status, and (Australia only) whether Xero has a super fund on file for them and their ordinary earnings rate id. Read-only, for Australian, New Zealand and United Kingdom organisations (this refuses plainly for any other country - Xero's Payroll API covers no other region). 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. Active employees only unless includeInactive is set. Employment status comes straight from Xero for Australia; for New Zealand and the United Kingdom, Xero sends no status field at all, so it is derived here from whether Xero has recorded an end date - still accurate, just not Xero's own word for it. Super/pension fund membership is ONLY available for Australia from this tool - for New Zealand and the United Kingdom that fact is simply not returned (never a guessed "no fund"), say so rather than assuming everyone lacks one. NEVER returns a tax file number, a bank account or a home address - this tool does not read them from Xero at all. Does NOT know, and cannot answer, whether an employee has been paid, or whether anything has been reported to the ATO (Australia), IRD (New Zealand) or HMRC (United Kingdom) - Xero has no API for lodgement or payment status in any of the three. Returns up to 100 employees for the requested page; treat a full page of 100 as possibly incomplete and ask for the next page rather than assuming it is everyone.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. Omit for page 1. | |
| 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. | |
| includeInactive | No | Include terminated employees too. Omit or false for active employees only (Xero's own EmployeeStatus: ACTIVE or TERMINATED). |