Xero Payroll (UK) Endpoint: GetPaySlip - Revision history

Nic at 03:27, 19 December 2023

2023-12-19T03:27:45Z

← Older revision		Revision as of 22:27, 18 December 2023
Line 288:		Line 288:
	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Payroll (UK) Endpoint: Employees\|Employees]]		:[[Xero Payroll (UK) Endpoint: Employees\|Employees]]
			:[[Xero Payroll (UK) Endpoint: PayItemsBenefits\|PayItemsBenefits]]
	:[[Xero Payroll (UK) Endpoint: PayItemsDeductions\|PayItemsDeductions]]		:[[Xero Payroll (UK) Endpoint: PayItemsDeductions\|PayItemsDeductions]]
			:[[Xero Payroll (UK) Endpoint: PayItemsEarningsOrders\|PayItemsEarningsOrders]]
	:[[Xero Payroll (UK) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]		:[[Xero Payroll (UK) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]
	:[[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]
	:[[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]
	~~:[[Xero Payroll (UK) Endpoint: PayItemsStatutoryDeductions\|PayItemsStatutoryDeductions]]~~
	~~:[[Xero Payroll (UK) Endpoint: PayItemsSuperannuations\|PayItemsSuperannuations]]~~
	:[[Xero Payroll (UK) Endpoint: PayRuns\|PayRuns]]		:[[Xero Payroll (UK) Endpoint: PayRuns\|PayRuns]]
	:[[Xero Payroll (UK) Endpoint: PayRunsExpanded\|PayRunsExpanded]]		:[[Xero Payroll (UK) Endpoint: PayRunsExpanded\|PayRunsExpanded]]

Nic at 04:47, 14 December 2023

2023-12-14T04:47:34Z

← Older revision		Revision as of 23:47, 13 December 2023
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''~~PaySlips~~''' [[Xero Payroll (~~New Zealand~~) Endpoints\|endpoint]] provides the list of payslips.		The Xero '''GetPaySlip''' [[Xero Payroll (UK) Endpoints\|endpoint]] provides the list of payslips.

	It is a [[Function Endpoints\|function]] that accepts a series of parameters.		It is a [[Function Endpoints\|function]] that accepts a series of parameters.

	You may also use the [[Xero Payroll (~~New Zealand~~) Endpoint: PaySlips\|PaySlips]] which provides similar data but for all known pay runs.		You may also use the [[Xero Payroll (UK) Endpoint: PaySlips\|PaySlips]] which provides similar data but for all known pay runs.

	To make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		To make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].
Line 12:		Line 12:
	== Parameters ==		== Parameters ==

	The ~~GetPayslip is~~ a [[Function Endpoints\|function]] that accepts the following parameters.		The GetPaySlipis a [[Function Endpoints\|function]] that accepts the following parameters.

	;PayslipID		;PayslipID
Line 21:		Line 21:
	== Fields ==		== Fields ==

	The following fields are available for the ~~PaySlips~~ endpoint.		The following fields are available for the GetPaySlip endpoint.

	;paySlipID		;paySlipID
Line 287:		Line 287:

	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: Employees\|Employees]]		:[[Xero Payroll (UK) Endpoint: Employees\|Employees]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsDeductions\|PayItemsDeductions]]		:[[Xero Payroll (UK) Endpoint: PayItemsDeductions\|PayItemsDeductions]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]		:[[Xero Payroll (UK) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsStatutoryDeductions\|PayItemsStatutoryDeductions]]		:[[Xero Payroll (UK) Endpoint: PayItemsStatutoryDeductions\|PayItemsStatutoryDeductions]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayItemsSuperannuations\|PayItemsSuperannuations]]		:[[Xero Payroll (UK) Endpoint: PayItemsSuperannuations\|PayItemsSuperannuations]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayRuns\|PayRuns]]		:[[Xero Payroll (UK) Endpoint: PayRuns\|PayRuns]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PayRunsExpanded\|PayRunsExpanded]]		:[[Xero Payroll (UK) Endpoint: PayRunsExpanded\|PayRunsExpanded]]
	:[[Xero Payroll (~~New Zealand~~) Endpoint: PaySlips\|PaySlips]]		:[[Xero Payroll (UK) Endpoint: PaySlips\|PaySlips]]


	== Related Topics ==		== Related Topics ==

	:[[Xero Payroll (~~New Zealand~~) Models]]		:[[Xero Payroll (UK) Models]]
	:[[Xero Payroll (~~New Zealand~~) Endpoints]]		:[[Xero Payroll (UK) Endpoints]]

Nic: Created page with "== Overview == The Xero '''PaySlips''' endpoint provides the list of payslips. It is a function that accepts..."

2023-12-14T04:46:19Z

Created page with "== Overview == The Xero '''PaySlips''' endpoint provides the list of payslips. It is a function that accepts..."

New page

== Overview ==

The Xero '''PaySlips''' [[Xero Payroll (New Zealand) Endpoints|endpoint]] provides the list of payslips.

It is a [[Function Endpoints|function]] that accepts a series of parameters.

You may also use the [[Xero Payroll (New Zealand) Endpoint: PaySlips|PaySlips]] which provides similar data but for all known pay runs.

To make full use of the data in this endpoint may require using [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].

== Parameters ==

The GetPayslip is a [[Function Endpoints|function]] that accepts the following parameters.

;PayslipID
:A [[Field Type: GUID|guid field]] that determines the payslip for which to retrieve data.
:This field is mandatory.

== Fields ==

The following fields are available for the PaySlips endpoint.

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

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

;employeeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: Employees|employee id]] associated with the payslip.

;firstName
:A [[Field Type: Text|text field]] that provides the first name of the employee.

;lastName
:A [[Field Type: Text|text field]] that provides the last name of the employee.

;paymentMethod
:A [[Field Type: Text|text field]] that provides the way in which the pay slip was paid.

;totalEarnings
:A [[Field Type: Decimal|decimal field]] that provides the total earnings amount of this payslip.

;grossEarnings
:A [[Field Type: Decimal|decimal field]] that provides the gross earnings amount of this payslip.

;totalPay
:A [[Field Type: Decimal|decimal field]] that provides the net pay.

;totalEmployerTaxes
:A [[Field Type: Decimal|decimal field]] that provides the total employer taxes of this payslip.

;totalEmployeeTaxes
:A [[Field Type: Decimal|decimal field]] that provides the total employee taxes of this payslip.

;totalDeductions
:A [[Field Type: Decimal|decimal field]] that provides the total deductions of this payslip.

;totalReimbursements
:A [[Field Type: Decimal|decimal field]] that provides the total reimbursement amount of this payslip.

;totalCourtOrders
:A [[Field Type: Decimal|decimal field]] that provides the total court ordered earning orders of this payslip.

;totalBenefits
:A [[Field Type: Decimal|decimal field]] that provides the total benefits of this payslip.

;bacsHash
:A [[Field Type: Text|text field]] that provides the BACS service user number.

;lastEdited
:A [[Field Type: DateTimeOffset|date time field]] that provides the last date this payslip was edited.

;earningsLines
:A [[Field Type: Table|table field]] that provides the earnings lines of the payslip. These represent earnings recorded as default pay.
:See [[#EarningsLines Fields|EarningsLines Fields]] for more information.

;leaveEarningsLines
:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings paid from accrued leave.
:See [[#LeaveEarningsLines Fields|LeaveEarningsLines Fields]] for more information.

;timesheetEarningsLines
:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (UK) Endpoint: Timesheets|timesheets]].
:See [[#TimesheetEarningsLines Fields|TimesheetEarningsLines Fields]] for more information.

;deductionLines
:A [[Field Type: Table|table field]] that provides the deduction lines of the payslip.
:See [[#DeductionLines Fields|DeductionLines Fields]] for more information.

;reimbursementLines
:A [[Field Type: Table|table field]] that provides the reimbursement lines of the payslip.
:See [[#ReimbursementLines Fields|ReimbursementLines Fields]] for more information.

;leaveAccrualLines
:A [[Field Type: Table|table field]] that provides the leave accrual lines of the payslip.
:See [[#LeaveAccrualLines Fields|LeaveAccrualLines Fields]] for more information.

;benefitLines
:A [[Field Type: Table|table field]] that provides the benefit lines of the payslip.
:See [[#BenefitLines Fields|Benefit Lines Fields]] for more information.

;paymentLines
:A [[Field Type: Table|table field]] that provides the payment lines of the payslip.
:See [[#PaymentLines Fields|PaymentLines Fields]] for more information.

;employeeTaxLines
:A [[Field Type: Table|table field]] that provides the employee tax lines of the payslip.
:See [[#TaxLines Fields|TaxLines Fields]] for more information.

;employerTaxLines
:A [[Field Type: Table|table field]] that provides the employer tax lines of the payslip.
:See [[#TaxLines Fields|TaxLines Fields]] for more information.

;courtOrderLines
:A [[Field Type: Table|table field]] that provides the court ordered earnings lines of the payslip.
:See [[#CourtOrderLines Fields|CourtOrderLines Fields]] for more information.

== EarningsLines Fields ==

The [[#Fields|EarningsLines Fields]] include the following sub fields. This is applicable to '''earningsLines''', '''leaveEarningsLines''' and '''timesheetEarningsLines'''.

;earningsLineID
:A [[Field Type: GUID|guid field]] that provides id associated with the pay slip line.

;earningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsEarningsRates|earnings rate id]] associated with this payslip line.

;displayName
:A [[Field Type: Text|text field]] that provides the name of the earnings rate.

;ratePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the rate per unit of this payslip line.

;numberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units of this payslip line.

;fixedAmount
:A [[Field Type: Decimal|decimal field]] that provides the fixed amount of this payslip line.
:This only applies to certain PayItemsEarningsRates.

;amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this payslip line.

== DeductionLines Fields ==

The [[#Fields|DeductionLines Fields]] include the following sub fields.

;deductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsDeductions|pay item deduction id]] associated with this payslip line.

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

;amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this pay slip line.

;percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate if applicable.

;subjectToTax
:A [[Field Type: Boolean|true/false field]] that indicates if the amount was subject to tax or not.

== ReimbursementLines Fields ==

The [[#Fields|ReimbursementLines Fields]] include the following sub fields.

;reimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes|pay item reimbursement type id]] associated with this payslip line.

;description
:A [[Field Type: Text|text field]] that provides the description for this payslip line.

;amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this payslip line.

;ratePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the rate per unit of this payslip line.

;numberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units of this payslip line.

== LeaveAccrualLines Fields ==

The [[#Fields|LeaveAccrualLines Fields]] include the following sub fields.

;leaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes|pay item leave type id]] associated with this payslip line.

;numberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units applicable for this payslip line.

== BenefitLines Fields ==

The [[#Fields|BenefitLines Fields]] include the following sub fields.

;benefitTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsBenefits|benefit type id]] associated with this payslip line.

;displayName
:A [[Field Type: Text|text field]] that provides the name for the pay slip line.

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

;fixedAmount
:A [[Field Type: Decimal|decimal field]] that provides the fixed amount (if applicable).

;percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate used to calculate the amount (if applicable).

;manualAdjustment
:A [[Field Type: Boolean|true/false field]] that indicates if the amount was manually adjusted.

== PaymentLines Fields ==

The [[#Fields|PaymentLines Fields]] include the following sub fields.

;paymentLineID
:A [[Field Type: GUID|guid field]] that provides the id of the payment line.

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

;accountNumber
:A [[Field Type: Text|text field]] that provides the account number for the payment,

;accountName
:A [[Field Type: Text|text field]] that provides the account name for the payment,

== TaxLines Fields ==

The [[#Fields|TaxLines Fields]] include the following sub fields. This applies to '''employeeTaxLines''' and '''employerTaxLines'''.

;taxLineID
:A [[Field Type: GUID|guid field]] that provides the id of the pay slip tax line.

;description
:A [[Field Type: Text|text field]] that provides the description of the tax.

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

;globalTaxTypeID
:A [[Field Type: GUID|guid field]] that provides the global tax type id of the pay slip tax line.

;manualAdjustment
:A [[Field Type: Boolean|true/false field]] that indicates if the amount was manually adjusted.

== CourtOrderLines Fields ==

The [[#Fields|CourtOrderedLines Fields]] include the following sub fields.

;courtOrderTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayItemsEarningsOrders|earnings orders type id]] associated with this payslip line.

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

;fixedAmount
:A [[Field Type: Decimal|decimal field]] that provides the fixed amount (if applicable).

;manualAdjustment
:A [[Field Type: Boolean|true/false field]] that indicates if the amount was manually adjusted.

== Xero API ==

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

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Payroll (New Zealand) Endpoint: Employees|Employees]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsDeductions|PayItemsDeductions]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsReimbursementTypes|PayItemsReimbursementTypes]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsStatutoryDeductions|PayItemsStatutoryDeductions]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsSuperannuations|PayItemsSuperannuations]]
:[[Xero Payroll (New Zealand) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]]
:[[Xero Payroll (New Zealand) Endpoint: PaySlips|PaySlips]]

== Related Topics ==

:[[Xero Payroll (New Zealand) Models]]
:[[Xero Payroll (New Zealand) Endpoints]]

← Older revision		Revision as of 22:27, 18 December 2023
Line 288:		Line 288:
	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
	:[[Xero Payroll (UK) Endpoint: Employees\|Employees]]		:[[Xero Payroll (UK) Endpoint: Employees\|Employees]]
			:[[Xero Payroll (UK) Endpoint: PayItemsBenefits\|PayItemsBenefits]]
	:[[Xero Payroll (UK) Endpoint: PayItemsDeductions\|PayItemsDeductions]]		:[[Xero Payroll (UK) Endpoint: PayItemsDeductions\|PayItemsDeductions]]
			:[[Xero Payroll (UK) Endpoint: PayItemsEarningsOrders\|PayItemsEarningsOrders]]
	:[[Xero Payroll (UK) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]		:[[Xero Payroll (UK) Endpoint: PayItemsEarningsRates\|PayItemsEarningsRates]]
	:[[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsLeaveTypes\|PayItemsLeaveTypes]]
	:[[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]		:[[Xero Payroll (UK) Endpoint: PayItemsReimbursementTypes\|PayItemsReimbursementTypes]]
	~~:[[Xero Payroll (UK) Endpoint: PayItemsStatutoryDeductions\|PayItemsStatutoryDeductions]]~~
	~~:[[Xero Payroll (UK) Endpoint: PayItemsSuperannuations\|PayItemsSuperannuations]]~~
	:[[Xero Payroll (UK) Endpoint: PayRuns\|PayRuns]]		:[[Xero Payroll (UK) Endpoint: PayRuns\|PayRuns]]
	:[[Xero Payroll (UK) Endpoint: PayRunsExpanded\|PayRunsExpanded]]		:[[Xero Payroll (UK) Endpoint: PayRunsExpanded\|PayRunsExpanded]]