Nic: Created page with "== Overview == The Xero '''PayRunsExpanded''' endpoint provides the list of pay runs. As this endpoint cannot be filtered, it is optimised to..."

2023-12-14T04:31:01Z

Created page with "== Overview == The Xero '''PayRunsExpanded''' endpoint provides the list of pay runs. As this endpoint cannot be filtered, it is optimised to..."

New page

== Overview ==

The Xero '''PayRunsExpanded''' [[Xero Payroll (UK) 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.

Alternatively, you can use the [[Xero Payroll (UK) Endpoint: GetPayRun|GetPayRun]] endpoint which is easier to optimise.

== Fields ==

The following fields are available for the PayRunsExpanded endpoint.

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

;payrollCalendarID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PayrollCalendars|payroll calendar id]] of the pay run.

;periodStartDate
:A [[Field Type: Date|date field]] that provides the start date of the pay run.

;periodEndDate
:A [[Field Type: Date|date field]] that provides the end date of the pay run.

;paymentDate
:A [[Field Type: Date|date field]] that provides the payment date of the pay run.

;postedDateTime
:A [[Field Type: DateTimeOffset|datetime field]] that provides the date and time the pay run was posted.

;payRunStatus
:A [[Field Type: Text|text field]] that provides the status of the pay run.
:Possible values are:
:* '''Draft'''
:* '''Posted'''

;payRunType
:A [[Field Type: Text|text field]] that provides the status of the pay run.
:Possible values are:
:* '''Scheduled''': Pay run that is using the normal pay run period.
:* '''Unscheduled''': Pay run that is not using the normal pay run period.
:* '''EarlierYearUpdate''': Pay run that is of Earlier Year Update.

;calendarType
:A [[Field Type: Text|text field]] that provides the status of the pay run.
:Possible values are:
:* '''Weekly'''
:* '''Fortnightly'''
:* '''TwiceMonthly'''
:* '''Monthly'''
:* '''FourWeekly'''

;payslipMessage
:A [[Field Type: Text|text field]] that provides the pay slip message attached to a pay run.

;totalCost
:A [[Field Type: Decimal|decimal field]] that provides the total costs of the pay run.

;totalPay
:A [[Field Type: Decimal|decimal field]] that provides the total paid amount of the pay run.

;paySlips
:A [[Field Type: Table|table field]] that provides the pay slips of the pay run.
:See [[#PaySlips Fields|PaySlips Fields]] for more information.

== PaySlips Fields ==

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

;paySlipID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (UK) Endpoint: PaySlips|payslip id]].

;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 earnings ordered of this payslip.

;totalBenefits
:A [[Field Type: Decimal|decimal field]] that provides the total benefits paid 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.

== Xero API ==

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

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Payroll (UK) Endpoint: Employees|Employees]]
:[[Xero Payroll (UK) Endpoint: GetPayRun|GetPayRun]]
:[[Xero Payroll (UK) Endpoint: PayrollCalendars|PayrollCalendars]]
:[[Xero Payroll (UK) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (UK) Endpoint: PaySlips|PaySlips]]

== Related Topics ==

:[[Xero Payroll (UK) Models]]
:[[Xero Payroll (UK) Endpoints]]

Xero Payroll (UK) Endpoint: PayRunsExpanded - Revision history

Nic: Created page with "== Overview == The Xero '''PayRunsExpanded''' endpoint provides the list of pay runs. As this endpoint cannot be filtered, it is optimised to..."