Xero Payroll (UK) Endpoint: PayItemsEarningsOrders
Jump to navigation
Jump to search
Overview
The Xero PayItemsEarningsOrders endpoint provides the list of benefit 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 PayItemsEarningsOrders endpoint.
- earningsOrderId
- A guid field that provides the id of the pay item.
- name
- A text field that provides the name of the pay item.
- statutoryDeductionCategory
- A text field that provides the type of deduction category of the pay item.
- Possible values are:
- StakeholderPension: Pre-Tax Pension (NPA)
- PriorityOrder: Priority Order
- NonPriorityOrder: Non-Priority Order
- TableBased: Table Based
- ChildSupport: Child Support
- CourtFines: Court Fines
- InlandRevenueArrears: Inland Revenue Arrears
- MsdRepayments: Ministry of Social Management(MSD) Repayments
- StudentLoan: Student Loan
- AdditionalStudentLoan: Additional Student Loan
- VoluntaryStudentLoan: Voluntary Student Loan
- KiwiSaver: KiwiSaver
- 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.
- currentRecord
- A true/false field that indicates if the pay item is active or not.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints