Xero Payroll (UK) Endpoint: PayItemsDeductions
Jump to navigation
Jump to search
Overview
The Xero PayItemDeductionTypes endpoint provides the list of deduction 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 PayItemDeductionTypes endpoint.
- deductionId
- A guid field that provides the id of the pay item.
- deductionName
- A text field that provides the name of the pay item.
- deductionCategory
- A text field that provides the type of deduction category of the pay item.
- Possible values are:
- PayrollGiving
- StakeholderPension: Pre-Tax Pension (NPA)
- StakeholderPensionPostTax: Post-Tax Pension (RAS)
- ChildCareVoucher: Child Care Voucher
- SalarySacrifice: Salary Sacrifice
- PostgraduateLoanDeductions: Postgraduate Loan Deductions
- MakingGood: Making Good
- PrivateUsePayments: Payments for Private Use Deductions
- CapitalContributions: Capital Contributions Deductions
- UkOther: Other for UK
- liabilityAccountId
- A guidfield that provides the 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.
- subjectToTax
- A true/false field that indicates if the deduction is subject to tax.
- isReducedByBasicRate
- A true/false field that indicates if the deduction is reduced by the basic rate or not.
- applyToPensionCalculations
- A true/false field that indicates if the deduction applies to pension calculations.
- isCalculatingOnQualifyingEarnings
- A true/false field that indicates if the deduction is calculated on qualifying earnings.
- isPension
- A true/false field that indicates if the deduction is related to pension.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints