Xero Payroll (UK) Endpoint: PayItemsDeductions - Revision history

Nic at 05:57, 15 December 2023

2023-12-15T05:57:04Z

← Older revision		Revision as of 00:57, 15 December 2023
Line 70:		Line 70:
	== Xero API ==		== Xero API ==

	For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/~~payrollnz~~/deductions Xero API].		For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrolluk/deductions Xero API].

Nic at 05:56, 15 December 2023

2023-12-15T05:56:41Z

← Older revision		Revision as of 00:56, 15 December 2023
Line 39:		Line 39:
	;calculationType		;calculationType
	:A [[Field Type: Text\|text field]] that provides the type of calculation this deduction applies.		:A [[Field Type: Text\|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		;standardAmount

Nic at 05:55, 15 December 2023

2023-12-15T05:55:17Z

← Older revision		Revision as of 00:55, 15 December 2023
Line 20:		Line 20:
	:Possible values are:		:Possible values are:
	:* '''PayrollGiving'''		:* '''PayrollGiving'''
	:* '''~~KiwiSaverVoluntaryContributions~~'''		:* '''StakeholderPension''': Pre-Tax Pension (NPA)
	:* '''~~Superannuation~~'''		:* '''StakeholderPensionPostTax''': Post-Tax Pension (RAS)
	:* '''~~NzOther~~'''		:* '''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		;liabilityAccountId

Nic: Created page with "== Overview == The Xero '''PayItemDeductionTypes''' endpoint provides the list of deduction pay items that can be used on payslips. To make f..."

2023-12-15T05:54:05Z

Created page with "== Overview == The Xero '''PayItemDeductionTypes''' endpoint provides the list of deduction pay items that can be used on payslips. To make f..."

New page

== Overview ==

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

== Fields ==

The following fields are available for the PayItemDeductionTypes endpoint.

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

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

;deductionCategory
:A [[Field Type: Text|text field]] that provides the type of deduction category of the pay item.
:Possible values are:
:* '''PayrollGiving'''
:* '''KiwiSaverVoluntaryContributions'''
:* '''Superannuation'''
:* '''NzOther'''

;liabilityAccountId
:A [[Field Type: GUID|guidfield]] that provides the 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.

;calculationType
:A [[Field Type: Text|text field]] that provides the type of calculation this deduction applies.

;standardAmount
:A [[Field Type: Decimal|decimal field]] that provides the default standard amount.

;percentage
:A [[Field Type: Decimal|decimal field]] that provides the default percentaged used to calculate the amount.

;subjectToNIC
:A [[Field Type: Boolean|true/false field]] that indicates if the deduction is subject to NIC.

;subjectToTax
:A [[Field Type: Boolean|true/false field]] that indicates if the deduction is subject to tax.

;isReducedByBasicRate
:A [[Field Type: Boolean|true/false field]] that indicates if the deduction is reduced by the basic rate or not.

;applyToPensionCalculations
:A [[Field Type: Boolean|true/false field]] that indicates if the deduction applies to pension calculations.

;isCalculatingOnQualifyingEarnings
:A [[Field Type: Boolean|true/false field]] that indicates if the deduction is calculated on qualifying earnings.

;isPension
:A [[Field Type: Boolean|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 [https://developer.xero.com/documentation/api/payrollnz/deductions 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]]