Xero Payroll (New Zealand) Endpoint: PaySlips: Difference between revisions

Created page with "== Overview == The Xero '''PaySlips''' endpoint provides the list of payslips. You can join data from this endpoint with Xero Payro..."
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
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.
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.
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]].
To make full use of the data in this endpoint may require using [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].
Line 159: Line 159:


;deductionTypeID
;deductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: PayItemsDeductionTypes|pay item deduction type id]] associated with this payslip line.
: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
;displayName
Line 328: Line 328:
:[[Xero Payroll (New Zealand) Endpoint: Employees|Employees]]
:[[Xero Payroll (New Zealand) Endpoint: Employees|Employees]]
:[[Xero Payroll (New Zealand) Endpoint: GetPaySlip|GetPaySlip]]
:[[Xero Payroll (New Zealand) Endpoint: GetPaySlip|GetPaySlip]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsDeductions|PayItemsDeductions]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (New Zealand) Endpoint: PayItemsReimbursementTypes|PayItemsReimbursementTypes]]
:[[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: PayRuns|PayRuns]]
:[[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]]
:[[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]]