View source for Xero Payroll (New Zealand) Endpoint: PaySlips

== Overview ==

The Xero '''PaySlips''' [[Xero Payroll (New Zealand) Endpoints|endpoint]] provides the list of payslips. You can join data from this endpoint with [[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]] to access additional information belonging to the Pay Run.

As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required. The [[Xero Payroll (New Zealand) Endpoint: GetPaySlip|GetPaySlip]] endpoint is easier to optimise.

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 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 (New Zealand) 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.

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

;totalSuperannuation
:A [[Field Type: Decimal|decimal field]] that provides the total superannuations 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 (New Zealand) 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.

;superannuationLines
:A [[Field Type: Table|table field]] that provides the superannuation lines of the payslip.
:See [[#SuperannuationLines Fields|SuperannuationLines 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.

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

;taxSettings
:A [[Field Type: Record|record field]] that provides the tax settings applicable for the pay slip.
:See [[#TaxSettings Fields|TaxSettings Fields]] for more information.

;grossEarningsHistory
:A [[Field Type: Record|record field]] that provides the gross earnings history applicable for the pay slip.
:See [[#GrossEarningsHistory Fields|GrossEarningsHistory 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 (New Zealand) 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.

;isLinkedToTimesheet
:A [[Field Type: Boolean|true/false field]] that indicates if the line is sourced from a timesheet.

;isAverageDailyPayRate
:A [[Field Type: Boolean|true/false field]] that indicates if it uses an average daily rate.

;isSystemGenerated
:A [[Field Type: Boolean|true/false field]] that indicates if it was system generated.


== DeductionLines Fields ==

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

;deductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) 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.


== ReimbursementLines Fields ==

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

;reimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) 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 (New Zealand) 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.


== SuperannuationLines Fields ==

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

;superannuationTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: PayItemsSuperannuations|superannuation 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.


== StatutoryDeductionLines Fields ==

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

;statutoryDeductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: PayItemsStatutoryDeductions|statutory deduction 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.


== TaxSettings Fields ==

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

;periodUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units in the period.

;periodType
:A [[Field Type: Text|text field]] that provides the type of periods.

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

;specialTaxRate
:A [[Field Type: Decimal|decimal field]] that provides the special tax rate (if applicable).

;lumpSumTaxCode
:A [[Field Type: Text|text field]] that provides the tax code for lump sum.

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


== GrossEarningsHistory Fields ==

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

;daysPaid
:A [[Field Type: Integer|whole number field]] that indicates the number of days paid.

;unpaidWeeks
:A [[Field Type: Integer|whole number field]] that indicates the number of weeks unpaid.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollnz/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: GetPaySlip|GetPaySlip]]
:[[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]]


== Related Topics ==

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