list_xero_payroll_earnings_rates
list_xero_payroll_earnings_ratesThis organisation's payroll earnings rates (Ordinary Time, Overtime and similar) - name, earnings type, rate type and, where set, the rate itself (a per-unit rate, a multiplier of the ordinary earnings rate, or a fixed amount - only one of the three applies, depending on rateType). Read-only, for Australian, New Zealand and United Kingdom organisations. For Australia, each employee's own ordinaryEarningsRateId (from list_xero_payroll_employees) remains the right default for that employee's own ordinary hours - use this tool when you need a DIFFERENT rate (overtime, an allowance, and similar), since Australia's full list is now readable too, not just the one rate an employee record carries. 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. Use this before drafting a New Zealand or United Kingdom timesheet (create_xero_timesheet) - each timesheet line needs a real earningsRateId, and an employee record for those two regions carries no earnings rate of its own to fall back on. When the user has not named a specific rate, use the one whose earningsType is RegularEarnings (New Zealand/United Kingdom) for ordinary hours worked; say so rather than guessing at a name. Returns up to 100 rates for the requested page.
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. |