---
title: "Retrieves pay runs"
method: GET
path: "/PayRuns"
tags: ["PayrollAu"]
---

# Retrieves pay runs

`GET /PayRuns`

## Query parameters

- `where` string
- `order` string
- `page` integer

## Headers

- `If-Modified-Since` string, date-time

## Response `200`

search results matching criteria

- PayRuns
  - `PayRuns` PayRun[]
    - `PayrollCalendarID` string, uuid, required — Xero identifier for pay run
    - `PayRunID` string, uuid — Xero identifier for pay run
    - `PayRunPeriodStartDate` string — Period Start Date for the PayRun (YYYY-MM-DD)
    - `PayRunPeriodEndDate` string — Period End Date for the PayRun (YYYY-MM-DD)
    - `PayRunStatus` 'DRAFT' | 'POSTED'
    - `PaymentDate` string — Payment Date for the PayRun (YYYY-MM-DD)
    - `PayslipMessage` string — Payslip message for the PayRun
    - `UpdatedDateUTC` string — Last modified timestamp
    - `Payslips` PayslipSummary[] — The payslips in the payrun
      - `EmployeeID` string, uuid — The Xero identifier for an employee
      - `PayslipID` string, uuid — Xero identifier for the payslip
      - `FirstName` string — First name of employee
      - `LastName` string — Last name of employee
      - `EmployeeGroup` string — Employee group name
      - `Wages` number, double — The Wages for the Payslip
      - `Deductions` number, double — The Deductions for the Payslip
      - `Tax` number, double — The Tax for the Payslip
      - `Super` number, double — The Super for the Payslip
      - `Reimbursements` number, double — The Reimbursements for the Payslip
      - `NetPay` number, double — The NetPay for the Payslip
      - `UpdatedDateUTC` string — Last modified timestamp
    - `Wages` number, double — The total Wages for the Payrun
    - `Deductions` number, double — The total Deductions for the Payrun
    - `Tax` number, double — The total Tax for the Payrun
    - `Super` number, double — The total Super for the Payrun
    - `Reimbursement` number, double — The total Reimbursements for the Payrun
    - `NetPay` number, double — The total NetPay for the Payrun
    - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API
      - `Message` string — Validation error message

## Other responses

- `400` — validation error for a bad request

---

[API](https://skmtc.net/xeroapi/apis/xero-payroll-au-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-payroll-au-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-payroll-au-api/versions/35651d98854e/schema)