View source for Xero Payroll (UK) Endpoint: PayItemsEarningsOrders

== Overview ==

The Xero '''PayItemsEarningsOrders''' [[Xero Payroll (UK) Endpoints|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 [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].


== Fields ==

The following fields are available for the PayItemsEarningsOrders endpoint.

;earningsOrderId
:A [[Field Type: GUID|guid field]] that provides the id of the pay item.

;name
:A [[Field Type: Text|text field]] that provides the name of the pay item.

;statutoryDeductionCategory
:A [[Field Type: Text|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 [[Field Type: GUID|guidfield]] that provides the liability account ID linked to the pay item.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the  [[Xero Accounting Models|Xero Accounting Model]].

;currentRecord
:A [[Field Type: Boolean|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 [https://developer.xero.com/documentation/api/payrolluk/earningsorders Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Payroll (UK) Endpoint: EmployeesPayTemplates|EmployeesPayTemplates]]
:[[Xero Payroll (UK) Endpoint: GetPaySlip|GetPaySlip]]
:[[Xero Payroll (UK) Endpoint: PaySlips|PaySlips]]


== Related Topics ==

:[[Xero Payroll (UK) Models]]
:[[Xero Payroll (UK) Endpoints]]