Xero Payroll (New Zealand) Endpoint: LeaveApplications

Overview

The Xero LeaveApplications endpoint provides the list of leave applications made by employees.

This includes all types of leave applications (applied, approved, rejected, etc.).


Fields

The following fields are available for the LeaveApplications endpoint.

employeeID
A guid field that provides the employee id associated with the leave application.
leaveID
A guid field that provides the id of this leave application.
leaveTypeID
A guid field that provides the leave type id associated with the leave application.
description
A text field that provides a description for the leave application.
startDate
A date field that provides the first date of leave.
endDate
A date field that provides the last date of leave.
periods
A table field that provides the list of pay periods that applies to the leave application.
See Periods Fields for more information.
updatedDateUTC
A date time field that indicates the last time this record was updated.


Periods Fields

The LeavePeriods Fields include the following sub fields.

periodStartDate
A date field that provides the start date of the pay period that overlaps this leave application.
periodEndDate
A date field that provides the end date of the pay period that overlaps this leave application.
numberOfUnits
A decimal field that provides the number of units (e.g. hours) applicable for this pay period and leave application.
periodStatus
A text field that indicates the status of this part of the leave application for the given pay period.
Possible values are:
  • Approved
  • Completed


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

None


Related Endpoints

Employees
EmployeesLeaveTypes
PayItemsLeaveTypes
GetPaySlip
PaySlips


Related Topics

Xero Payroll (New Zealand) Models
Xero Payroll (New Zealand) Endpoints