Xero Payroll (UK) Endpoint: PayItemsEarningsRates
Overview
The Xero PayItemEarningsRates endpoint provides the list of earnings rate pay items that can be used on payslips.
To make full use of the data in this endpoint may require using endpoints belonging to a Xero Accounting Model.
Fields
The following fields are available for the PayItemEarningsRates endpoint.
- earningsRateID
- A guid field that provides the id of the pay item.
- name
- A text field that provides the name of the pay item.
- Possible values are:
- Regular Hours
- Overtime Hours
- Bonus
- Statutory Adoption Pay
- Statutory Maternity Pay
- Statutory Paternity Pay
- Statutory Shared Parental Pay
- Statutory Sick Pay
- Statutory Bereavement Pay
- Statutory Neonatal Care Pay
- Statutory Adoption Pay (Non Pensionable)
- Statutory Maternity Pay (Non Pensionable)
- Statutory Paternity Pay (Non Pensionable)
- Statutory Shared Parental Pay (Non Pensionable)
- Statutory Sick Pay (Non Pensionable)
- Statutory Bereavement Pay (Non Pensionable)
- Statutory Neonatal Care Pay (Non Pensionable)
- earningsType
- A text field that provides the type of earnings rate for HMRC purposes.
- rateType
- A text field that provides the calculation type of the earnings rate.
- Possible values are:
- RegularEarnings
- OvertimeEarnings
- Bonus
- StatutoryAdoptionPay
- StatutoryMaternityPay
- StatutoryPaternityPay
- StatutorySharedParentalPay
- StatutorySickPay
- StatutoryBereavementPay
- StatutoryNeonatalCarePay
- currentRecord
- A true/false field that indicates if the pay item is active or not.
- expenseAccountID
- A text field that provides the account id linked to the pay item.
- This field links with the Accounts endpoint of the Xero Accounting Model.
- fixedAmount
- A decimal field that provides the actual amount for fixed earnings rates.
- ratePerUnit
- A decimal field that provides the actual rate for some earnings rates.
- multipleOfOrdinaryEarningsRate
- A decimal field that provides the multipler (time and half, double time, etc.) for some earnings rates.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints