PayItemsLeave
Allows you to manage leave-related pay items. It is used to query, insert, and update leave accruals, including annual leave and sick leave.
Columns
| Name | Type | ReadOnly | Filterable | Description |
| LeaveTypeID [KEY] | String | True |
The unique identifier assigned by Xero to the leave type PayItem. This ensures that each leave type is distinct and can be easily referenced for payroll and leave management purposes. | |
| Name | String | False |
The name of the leave type, such as 'Annual Leave' or 'Sick Leave'. This field helps identify the type of leave being applied to an employee's record. | |
| TypeOfUnits | String | False |
The unit type used to measure and track leave entitlements, such as 'hours', 'days', or 'weeks'. This determines how leave balances are calculated and recorded for the employee. | |
| IsPaidLeave | Boolean | False |
Indicates whether the leave type is paid or unpaid. When set to 'paid', the employee will receive their regular pay while on leave. This is typically applied to annual leave or sick leave. | |
| ShowOnPayslip | Boolean | False |
Set this field to 'true' if you want the balance of this leave type to appear on the employee's payslips. This is useful for employees to see how much paid or unpaid leave they have remaining. | |
| NormalEntitlement | Double | False |
The standard number of leave units the employee is entitled to each year for this leave type. For example, '20 days' of annual leave or '10 days' of sick leave per year. | |
| LeaveLoadingRate | Double | False |
Enter the additional percentage (typically 17.5%) that is paid on top of the employee's regular earnings when they take leave. This is commonly applied in countries like Australia for certain leave types. | |
| UpdatedDateUTC | Datetime | True |
The timestamp indicating the last time this leave type record was updated. This helps keep track of changes and ensures that the most up-to-date leave policies are being applied. | |
| TenantId [KEY] | String | False |
The unique identifier of the tenant (organization) to query instead of the connection tenant. This ensures that the data is retrieved from the correct organization within Xero, especially for organizations managing multiple companies. | |
| CurrentRecord | Boolean | False |
Indicates whether this leave type is currently active and available for use in payroll. When false, the leave type has been archived. | |
| LeaveCategoryCode | String | False |
The leave category code for STP2 reporting, used to classify the type of leave being taken by the employee. | |
| SGCExempt | Boolean | False |
Indicates whether this leave type is exempt from Superannuation Guarantee Contribution (SGC) calculations. | |
| IsQualifyingEarnings | Boolean | False |
Indicates whether this leave type contributes to qualifying earnings for superannuation guarantee purposes. |