Xero Payroll (New Zealand) Endpoint: EmployeesLeaveTypes
Jump to navigation
Jump to search
Overview
The Xero EmployeesLeaveTypes endpoint provides the list of employee specific settings relating to leave types.
Fields
The following fields are available for the EmployeesLeaveTypes endpoint.
- employeeID
- A guid field that provides the id of the linked employee.
- leaveTypeID
- A guid field that provides the id of the linked leave type.
- scheduleOfAccrual
- A text field that provides the way in which leave accrues.
- Possible values are:
- AnnuallyAfter6Months: Leave is accrued every six months
- OnAnniversaryDate: Leave is accrued every anniversary date
- PercentageOfGrossEarnings: Leave is accrued as a percentage of Gross Earnings. Only applicable for Holiday Pay
- NoAccruals: Leave does not accrue
- hoursAccruedAnnually
- A decimal field that provides the number of hours accrued annually.
- maximumToAccrue
- A decimal field that provides the maximum number of hours that can be accrued.
- openingBalance
- A decimal field that provides the initial opening balance when the leave type was first assigned to the employee.
- rateAccruedHourly
- A decimal field that provides the number of hours accrued for each hour worked.
- percentageOfGrossEarnings
- A decimal field that provides the percentage of gross earnings used to accrue leave.
- Only applicable if scheduleOfAccrual is PercentageOfGrossEarnings.
- includeHolidayPayEveryPay
- A true/false field that indicates if holiday pay is included in every pay run.
- showAnnualLeaveInAdvance
- A true/false field that indicates if leave is available to take in advance in the balance of the pay slip.
- annualLeaveTotalAmountPaid
- A decimal field that provides the total annual leave balance in dollars.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints