Xero Payroll (New Zealand) Endpoint: GetPayRun
Overview
The Xero GetPayRun endpoint provides fields for a specific pay run.
It is a function that accepts a series of parameters.
You may also use the PayRunsExpanded which provides similar data but for all known pay runs.
Parameters
The GetPayRun is a function that accepts the following parameters.
- PayRunID
- A 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 guid field that provides the id of the pay run.
- payrollCalendarID
- A guid field that provides the payroll calendar id of the pay run.
- periodStartDate
- A date field that provides the start date of the pay run.
- periodEndDate
- A date field that provides the end date of the pay run.
- paymentDate
- A date field that provides the payment date of the pay run.
- postedDateTime
- A datetime field that provides the date and time the pay run was posted.
- payRunStatus
- A text field that provides the status of the pay run.
- Possible values are:
- Draft
- Posted
- payRunType
- A 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 text field that provides the status of the pay run.
- Possible values are:
- Weekly
- Fortnightly
- TwiceMonthly
- Monthly
- FourWeekly
- payslipMessage
- A text field that provides the pay slip message attached to a pay run.
- totalCost
- A decimal field that provides the total costs of the pay run.
- totalPay
- A decimal field that provides the total paid amount of the pay run.
- paySlips
- A table field that provides the pay slips of the pay run.
- See PaySlips Fields for more information.
PaySlips Fields
The PaySlips Fields include the following sub fields.
- paySlipID
- A guid field that provides the payslip id.
- employeeID
- A guid field that provides the employee id associated with the payslip.
- firstName
- A text field that provides the first name of the employee.
- lastName
- A text field that provides the last name of the employee.
- paymentMethod
- A text field that provides the way in which the pay slip was paid.
- totalEarnings
- A decimal field that provides the total earnings amount of this payslip.
- grossEarnings
- A decimal field that provides the gross earnings amount of this payslip.
- totalPay
- A decimal field that provides the net pay.
- totalEmployerTaxes
- A decimal field that provides the total employer taxes of this payslip.
- totalEmployeeTaxes
- A decimal field that provides the total employee taxes of this payslip.
- totalDeductions
- A decimal field that provides the total deductions of this payslip.
- totalReimbursements
- A decimal field that provides the total reimbursement amount of this payslip.
- totalStatutoryDeductions
- A decimal field that provides the total statutory deductions of this payslip.
- totalSuperannuation
- A decimal field that provides the total superannuations of this payslip.
- bacsHash
- A text field that provides the BACS service user number.
- lastEdited
- A 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 Xero API.
Related Fields
- None
Related Endpoints