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

== Overview ==

The Xero '''GetPayRun''' [[Xero Payroll (New Zealand) Endpoints|endpoint]] provides fields for a specific pay run.

It is a [[Function Endpoints|function]] that accepts a series of parameters.

You may also use the [[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]] which provides similar data but for all known pay runs.


== Parameters ==

The GetPayRun is a [[Function Endpoints|function]] that accepts the following parameters.

;PayRunID
:A [[Field Type: GUID|guid field]] that determines the pay run for which to retrieve data.
:This field is mandatory.


== Fields ==

The following fields are available for the GetPayRun 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 (New Zealand) 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 (New Zealand) Endpoint: PaySlips|payslip id]].

;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.


== 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 (New Zealand) Endpoint: Employees|Employees]]
:[[Xero Payroll (New Zealand) Endpoint: PayrollCalendars|PayrollCalendars]]
:[[Xero Payroll (New Zealand) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]]
:[[Xero Payroll (New Zealand) Endpoint: PaySlips|PaySlips]]


== Related Topics ==

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