Xero Payroll (Australia) Endpoint: PayRuns
Jump to navigation
Jump to search
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.
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.
- 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