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

(3 intermediate revisions by the same user not shown)

Line 3:

The Xero '''PayRuns''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of pay runs.

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. Alternatively, you can use the [[Xero Payroll (Australia) Endpoint: GetPayRun|GetPayRun]] endpoint which 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~~.

== Fields ==

The following fields are available for the ~~PayRunsExpanded~~ endpoint.

The following fields are available for the PayRuns endpoint.

;PayRunID

Line 69:

Line 67:

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

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

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

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

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

@@ Line 3: / Line 3: @@
 The Xero '''PayRuns''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of pay runs.
-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. Alternatively, you can use the [[Xero Payroll (Australia) Endpoint: GetPayRun|GetPayRun]] endpoint which 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.
 == Fields ==
-The following fields are available for the PayRunsExpanded endpoint.
+The following fields are available for the PayRuns endpoint.
 ;PayRunID
@@ Line 69: / Line 67: @@
 :[[Xero Payroll (Australia) Endpoint: Employees|Employees]]
 :[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
+:[[Xero Payroll (Australia) Endpoint: GetPayRun|GetPayRun]]
 :[[Xero Payroll (Australia) Endpoint: PayrollCalendars|PayrollCalendars]]
 :[[Xero Payroll (Australia) Endpoint: PayRunsExpanded|PayRunsExpanded]]