View source for Xero Payroll (Australia) Endpoint: LeaveApplications

== Overview ==

The Xero '''LeaveApplications''' [[Xero Payroll (Australia) Endpoints|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.

;LeaveApplicationID
:A [[Field Type: GUID|guid field]] that provides the id of the leave application.

;EmployeeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: Employees|employee id]] associated with the leave application.

;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|leave type id]] associated with the leave application.

;Title
:A [[Field Type: Text|text field]] that provides the title for the leave application.

;Description
:A [[Field Type: Text|text field]] that provides a description for the leave application.

;StartDate
:A [[Field Type: Date|date field]] that provides the first date of leave.

;EndDate
:A [[Field Type: Date|date field]] that provides the last date of leave.

;LeavePeriods
:A [[Field Type: Table|table field]] that provides the list of pay periods that applies to the leave application.
:See [[#LeavePeriods Fields|LeavePeriods Fields]] for more information.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.


== LeavePeriods Fields ==

The [[#Fields|LeavePeriods Fields]] include the following sub fields.

;PayPeriodStartDate
:A [[Field Type: Date|date field]] that provides the start date of the pay period that overlaps this leave application.

;PayPeriodEndDate
:A [[Field Type: Date|date field]] that provides the end date of the pay period that overlaps this leave application.

;LeavePeriodStatus
:A [[Field Type: Text|text field]] that indicates the status of this part of the leave application for the given pay period.
:Possible values are:
:* '''REQUESTED''': The leave application has not been requested but not yet approved.
:* '''SCHEDULED''': The leave application has been approved but has not yet been processed.
:* '''PROCESSED''': The leave application has been processed.
:* '''REJECTED''': The leave application is not approved.

;NumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units (e.g. hours) applicable for this pay period and leave application.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollau/leaveapplications Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Payroll (Australia) Endpoint: Employees|Employees]]
:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
:[[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (Australia) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (Australia) Endpoint: PayRunsExpanded|PayRunsExpanded]]
:[[Xero Payroll (Australia) Endpoint: Payslips|Payslips]]


== Related Topics ==

:[[Xero Payroll (Australia) Models]]
:[[Xero Payroll (Australia) Endpoints]]


== Changes Log ==

;OdataLink v2024.5.22.209
:Updated LeaveApplications endpoint for [[Xero Payroll (Australia) Models|Payroll (AU)]] to use v2 that provides access to REQUESTED and REJECTED leave applications.