Xero Payroll (Australia) Endpoint: PayRunsExpanded
Overview
The Xero PayRunsExpanded endpoint provides the list of pay runs.
This endpoint includes summary information for payslips but not all details. Furthermore, if you simply require summary pay run information, we recommend you use the PayRuns instead.
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.
Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required.
Fields
The following fields are available for the PayRunsExpanded 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.
- PayRunPeriodStartDate
- A date field that provides the start date of the pay run.
- PayRunPeriodEndDate
- 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.
- PayRunStatus
- A text field that provides the status of the pay run.
- Possible values are:
- DRAFT
- POSTED
- Wages
- A decimal field that provides the total wage amount of the pay run.
- Deductions
- A decimal field that provides the total deduction amount of the pay run.
- Tax
- A decimal field that provides the total tax amount of the pay run.
- Super
- A decimal field that provides the total superannuation amount of the pay run.
- Reimbursement
- A decimal field that provides the total reimbursement amount of the pay run.
- NetPay
- A decimal field that provides the net pay amount of the pay run.
- Payslips
- A table field that provides the pay slips of the pay run.
- See Payslips Fields for more information.
- UpdatedDateUTC
- A date time field that indicates the last time this record was updated.
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.
- LastEdited
- A date time field that provides the last date this payslip was edited.
- Wages
- A decimal field that provides the total wages amount of this payslip.
- Deductions
- A decimal field that provides the total deduction amount of this payslip.
- Tax
- A decimal field that provides the total tax amount of this payslip.
- Super
- A decimal field that provides the total super amount of this payslip.
- Reimbursements
- A decimal field that provides the total reimbursement amount of this payslip.
- NetPay
- A decimal field that provides the net pay amount of this payslip.
- UpdatedDateUTC
- A date time field that indicates the last time this record was updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints