Xero Payroll (Australia) Endpoint: GetPayRun
Jump to navigation
Jump to search
Overview
The Xero GetPayRun endpoint provides the 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.
- 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