Skip to main content
Skip table of contents

HR Leave Request

URL

Verbs

Function

Available

/HRLeaveRequest

GET

Query a list of all HR Leave Requests

2019.1

/HRLeaveRequest/<reference>

GET

Query a single HR Leave Request by its reference

2019.1
/HRLeaveRequestPOSTAdd a new HR Leave Request2019.1
/HRLeaveRequest/<reference>POSTUpdate an existing HR Leave Request2019.1

Supported modifiers

Query String

Definition

Sample
Available
statusReturn HR Leave Requests of a particular status, supports array of values delimited by |status=Approved2023.2 – &status= Approval|Approved array of values supported
treeName and treeBranchReturn a list of HR Leave Requests assigned to a nominated branch of a nominated treetreeName=Colour-AUS&treeBranch=Blue 
personReturn a list of HR Leave Requests for a specific HR Personperson=1000 
leaveTypeReturn HR Leave Requests of a particular typeleaveType=201 
fromDateReturn HR Leave Requests that end before this datefromDate=2017-01-12 
toDateReturn HR Leave Requests that start after this datetoDate=2018-01-31  
action

Allow you to perform the following actions on a HR Leave Request

  • Submit - submit the Leave Request
  • Cancel - cancel the Leave Request
action=submit or action=cancel 
assignedTeamReturn a list of HR Leave Requests for a specific TeamassignedTeam=HR Monthly 2023.1
canBeApprovedByUserReturn a list of HR Leave Requests that can be approved by a User canBeApprovedByUser=Super 2023.1
canBeApprovedByTeamReturn a list of HR Leave Requests that can be approved by any Team member canBeApprovedByTeam=HR Monthly 2023.1

Security Linked Menu

Menu Item
Located
Leave Request EntryHR / Leave Planning

Sample XML Response

<?xml version="1.0" encoding="UTF-8"?>
<HRLeaveRequest>
    <Reference>1000</Reference>
    <Reason/>
    <Edition>8</Edition>
    <Person>1000</Person>
    <LeaveType>202</LeaveType>
    <Status>Approved</Status>
    <IsEmailOnApproval>true</IsEmailOnApproval>
    <Notes/>
    <DateAdvance>2011-06-17</DateAdvance>
    <DateFrom>2011-06-18</DateFrom>
    <DateTo>2011-06-22</DateTo>
    <IsTimeRange>false</IsTimeRange>
    <TimeFrom>00:00:00</TimeFrom>
    <TimeTo>00:00:00</TimeTo>
    <UseEnteredLeave>false</UseEnteredLeave>
    <EnteredLeave>0.0000</EnteredLeave>
    <CalculatedDays>5.0000</CalculatedDays>
    <CalculatedHours>40.0000</CalculatedHours>
    <CalculatedWeeks>0.6000</CalculatedWeeks>
    <CancelReason/>
    <RejectedReason/>
    <IsEnterable>false</IsEnterable>
    <CanBeCancelled>true</CanBeCancelled>
    <CanBeDeleted>false</CanBeDeleted>
    <CanBeSubmitted>false</CanBeSubmitted>
    <UserDefinedFields collection='true' count='0'/>
    <Trees collection='true' count='0'/>
</HRLeaveRequest>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.