Xero Payroll (UK) Endpoint: PayRuns
Overview
The Xero PayRuns endpoint provides the list of pay runs.
As this endpoint cannot be filtered, it is optimised to pull payslips based on the model's Default Start Date and Default End Date. See Editing a model's details for more information.
Alternatively, you can use the GetPayRun endpoint which is easier to optimise.
Fields
The following fields are available for the PayRuns 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.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints