EmployeePayTemplateLeave
Allows querying the leave lines in an employee's pay template. Leave lines track the employee's leave entitlements, such as annual, sick, and other leave types.
Columns
| Name | Type | Filterable | Description |
| EmployeeID | String | The unique identifier for the employee, automatically assigned by Xero. | |
| LeaveTypeID | String | The unique identifier for the leave type applied to this leave line item. It links to a predefined leave type. | |
| CalculationType | String | Specifies how the leave amount is calculated. Possible values are 'FIXEDAMOUNTEACHPERIOD' (fixed leave accrual per period), 'ENTIRERATEINPAYTEMPLATE' (leave rate as per the pay template), or 'BASEDONORDINARYEARNINGS' (leave based on the employee's ordinary earnings). | |
| AnnualNumberOfUnits | Decimal | The total number of hours of leave accrued by the employee each year. | |
| FullTimeNumberOfUnitsPerPeriod | Decimal | The number of hours of leave accrued by the employee per pay period (for full-time employees). | |
| NumberOfUnits | Decimal | The fixed amount of leave (may be used for ad-hoc leave amounts). | |
| EntitlementFinalPayPayoutType | String | The type of payout for the employee's final leave entitlement. Possible values are 'NOTPAIDOUT' (leave not paid out) or 'PAIDOUT' (leave paid out). | |
| EmploymentTerminationPaymentType | String | The type of employment termination payment. Valid only if the 'EntitlementFinalPayPayoutType' is 'PAIDOUT'. Possible values are 'O' (Other) or 'R' (Resignation). | |
| IncludeSuperannuationGuaranteeContribution | Boolean | Indicates whether the Employment Termination Payment (ETP) leave earnings are subject to the Superannuation Guarantee Contribution (SGC). | |
| TenantId | String | The unique identifier for the tenant, allowing the query to target a specific tenant instead of the default connection tenant. |