Xero Payroll (Australia) Endpoint: LeaveApplications - Revision history

Nic at 23:31, 22 May 2024

2024-05-22T23:31:48Z

← Older revision		Revision as of 18:31, 22 May 2024
Line 89:		Line 89:
	== Changes Log ==		== Changes Log ==

	;OdataLink v2024.5.20.~~208~~		;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.		:Updated LeaveApplications endpoint for [[Xero Payroll (Australia) Models\|Payroll (AU)]] to use v2 that provides access to REQUESTED and REJECTED leave applications.

Nic at 23:31, 22 May 2024

2024-05-22T23:31:08Z

← Older revision		Revision as of 18:31, 22 May 2024
Line 90:		Line 90:

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

Nic at 23:30, 22 May 2024

2024-05-22T23:30:22Z

← Older revision		Revision as of 18:30, 22 May 2024
Line 90:		Line 90:

	;OdataLink v2024.5.20.208		;OdataLink v2024.5.20.208
	:Updated ~~Leave Applications~~ endpoint for [[Xero Payroll (Australia) Model\|Payroll (AU)]] to use v2 that provides access to REQUESTED and REJECTED leave applications.		:Updated LeaveApplications endpoint for [[Xero Payroll (Australia) Model\|Payroll (AU)]] to use v2 that provides access to REQUESTED and REJECTED leave applications.

Nic at 23:29, 22 May 2024

2024-05-22T23:29:41Z

← Older revision		Revision as of 18:29, 22 May 2024
Line 85:		Line 85:
	:[[Xero Payroll (Australia) Models]]		:[[Xero Payroll (Australia) Models]]
	:[[Xero Payroll (Australia) Endpoints]]		:[[Xero Payroll (Australia) Endpoints]]


			== Changes Log ==

			;OdataLink v2024.5.20.208
			:Updated Leave Applications endpoint for [[Xero Payroll (Australia) Model\|Payroll (AU)]] to use v2 that provides access to REQUESTED and REJECTED leave applications.

Nic at 05:15, 22 May 2024

2024-05-22T05:15:59Z

← Older revision		Revision as of 00:15, 22 May 2024
Line 52:		Line 52:
	:A [[Field Type: Text\|text field]] that indicates the status of this part of the leave application for the given pay period.		: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:		:Possible values are:
	:* '''~~Scheduled~~'''		:* '''REQUESTED''': The leave application has not been requested but not yet approved.
	:* '''~~Processed~~'''		:* '''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		;NumberOfUnits

Nic at 04:54, 18 January 2022

2022-01-18T04:54:18Z

← Older revision		Revision as of 23:54, 17 January 2022
Line 44:		Line 44:

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

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

	;LeavePeriodStatus		;LeavePeriodStatus

Nic at 00:24, 23 September 2021

2021-09-23T00:24:21Z

← Older revision		Revision as of 19:24, 22 September 2021
Line 14:		Line 14:

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

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

	;Title		;Title

Nic: Created page with "== Overview == The Xero '''LeaveApplications''' endpoint provides the list of leave applications made by employees. This includes all..."

2021-09-22T23:30:37Z

Created page with "== Overview == The Xero '''LeaveApplications''' endpoint provides the list of leave applications made by employees. This includes all..."

New page

== 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: Text|text field]] that provides the [[Xero Payroll (Australia) Endpoint: Employees|employee id]] associated with the leave application.

;LeaveTypeID
:A [[Field Type: Text|text 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 applicaton.

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

;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:
:* '''Scheduled'''
:* '''Processed'''

;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]]