Xero Payroll (UK) Endpoint: PayItemsBenefits
Jump to navigation
Jump to search
Overview
The Xero PayItemBenefits endpoint provides the list of benefit pay items that can be used on payslips. At the moment, Xero will only return 'employer pensions' type of benefits.
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 PayItemBenefits endpoint.
- benefitId
- A guid field that provides the id of the pay item.
- name
- A text field that provides the name of the pay item.
- category
- A text field that provides the type of deduction category of the pay item.
- Possible values are:
- StakeholderPension: Pre-Tax Pension (NPA)
- liabilityAccountId
- A guidfield that provides the liability account ID linked to the pay item.
- This field links with the Accounts endpoint of the Xero Accounting Model.
- expenseAccountId
- A guidfield that provides the expense account ID linked to the pay item.
- This field links with the Accounts endpoint of the Xero Accounting Model.
- currentRecord
- A true/false field that indicates if the pay item is active or not.
- calculationType
- A text field that provides the type of calculation this deduction applies.
- Possible values are:
- FixedAmount: Is a fixed amount and uses the standardAmount field.
- PercentageOfGross: Is a percentage and uses the percentage field.
- standardAmount
- A decimal field that provides the default standard amount.
- percentage
- A decimal field that provides the default percentaged used to calculate the amount.
- subjectToNIC
- A true/false field that indicates if the deduction is subject to NIC.
- subjectToPension
- A true/false field that indicates if the deduction is subject to pension.
- subjectToTax
- A true/false field that indicates if the deduction is subject to tax.
- isCalculatingOnQualifyingEarnings
- A true/false field that indicates if the deduction is calculated on qualifying earnings.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints