PayRuns
Used to query, insert, and update pay runs. A pay run represents the payroll process for a specific pay period and includes all employee payments, deductions, and taxes.
Columns
| Name | Type | ReadOnly | Filterable | Description |
| PayRunID [KEY] | String | True |
The unique identifier assigned by Xero to the payrun. This field helps in uniquely tracking and managing individual payruns within the payroll system. | |
| PayrollCalendarID | String | False |
The identifier for the payroll calendar associated with the payrun. This links the payrun to a specific payroll calendar, determining the pay schedule (for example, weekly, bi-weekly, or monthly). | |
| PayRunPeriodStartDate | String | False |
The start date of the period for which the payrun is being processed. This date marks the beginning of the pay cycle and is critical for calculating earnings and deductions. | |
| PayRunPeriodEndDate | String | False |
The end date of the period for the payrun. This date marks the conclusion of the pay cycle, helping to finalize the earnings and deductions for that period. | |
| PayRunStatus | String | False |
The current status of the payrun. Valid values include 'ACTIVE' (indicating the payrun is still being processed) and 'DELETED' (indicating that the payrun has been canceled). | |
| PaymentDate | String | False |
The date on which the payment will be made to the employees for this payrun. This is the actual date employees will receive their pay. | |
| PayslipMessage | String | False |
A customizable message that can be included on the payslip for this payrun. This field allows for communication to employees regarding their payrun. | |
| Wages | Decimal | False |
The total wages calculated for the payrun. This value includes all earnings before any deductions, taxes, or adjustments are applied. | |
| Deductions | Decimal | False |
The total amount deducted from employee wages for the payrun. This may include taxes, superannuation contributions, and other deductions. | |
| Tax | Decimal | False |
The total amount of tax withheld for the payrun. This is typically based on the employee's tax rate, allowances, and other tax considerations. | |
| Super | Decimal | False |
The total superannuation contributions made on behalf of employees for the payrun. This is typically a percentage of the employee's wages. | |
| Reimbursement | Decimal | False |
The total amount of reimbursements issued to employees in the payrun. This could include amounts reimbursed for business expenses or other agreed-upon reimbursements. | |
| NetPay | Decimal | False |
The final amount paid to the employee after all deductions, taxes, and adjustments. This is the amount the employee will actually receive. | |
| UpdatedDateUTC | Datetime | True |
The timestamp indicating the last change made to the payrun record. This helps track when the payrun details were last updated or modified. | |
| Payslip | String | False |
The payslip for this payrun in XML format. The payslip contains detailed information about the employee's earnings, deductions, and net pay. | |
| TenantId | String | False |
The unique identifier of the tenant (organization) associated with the payrun. This ensures that the payrun is linked to the correct organization when managing multiple tenants. |