Xero Payroll (Australia) Endpoint: Payslips: Difference between revisions

(8 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of payslips.

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

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

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 (Australia) 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]].

Line 40:

Line 44:

;TimesheetEarningsLines

:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (Australia) ~~Endpoints~~: Timesheets|timesheets]].

:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (Australia) Endpoint: Timesheets|timesheets]].

:See [[#TimesheetEarningsLines Fields|TimesheetEarningsLines Fields]] for more information.

Line 182:

Line 186:

:Possible values are:

:* '''SGC''': Indicates this is a mandatory contribution.

'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries

:* '''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries

'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries

:* '''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries

'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution

:* '''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution

;CalculationType

Line 259:

Line 263:

:[[Xero Payroll (Australia) Endpoint: Employees|Employees]]

:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]

:[[Xero Payroll (Australia) Endpoint: GetPayslip|GetPayslip]]

:[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]

:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of payslips.
+The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of payslips. You can join data from this endpoint with [[Xero Payroll (Australia) Endpoint: PayRunsExpanded|PayRunsExpanded]] to access additional information belonging to the Pay Run.
-Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].
+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 (Australia) 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]].
@@ Line 40: / Line 44: @@
 ;TimesheetEarningsLines
-:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip.  These represent earnings captured from [[Xero Payroll (Australia) Endpoints: Timesheets|timesheets]].
+:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip.  These represent earnings captured from [[Xero Payroll (Australia) Endpoint: Timesheets|timesheets]].
 :See [[#TimesheetEarningsLines Fields|TimesheetEarningsLines Fields]] for more information.
@@ Line 182: / Line 186: @@
 :Possible values are:
 :* '''SGC''': Indicates this is a mandatory contribution.
-'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
+:* '''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
-'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
+:* '''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
-'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution
+:* '''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution
 ;CalculationType
@@ Line 259: / Line 263: @@
 :[[Xero Payroll (Australia) Endpoint: Employees|Employees]]
 :[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
+:[[Xero Payroll (Australia) Endpoint: GetPayslip|GetPayslip]]
 :[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]
 :[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]