PayrollAu

Retrieves leave applications

get/LeaveApplications

Request

Base URL: https://api.xero.com/payroll.xro/1.0
URL: https://api.xero.com/payroll.xro/1.0/LeaveApplications
Auth: OAuth 2 (authorization code, authorization URL https://login.xero.com/identity/connect/authorize, token URL https://identity.xero.com/connect/token, scopes: payroll.employees, payroll.employees.read)

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

pageinteger

e.g. page=1 – Up to 100 objects will be returned in a single API call

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

search results matching criteria

Example response

{
  "LeaveApplications": [
    {
      "LeaveApplicationID": "e0eb6747-7c17-4075-b804-989f8d4e5d39",
      "EmployeeID": "fb4ebd68-6568-41eb-96ab-628a0f54b4b8",
      "LeaveTypeID": "742998cb-7584-4ecf-aa88-d694f59c50f9",
      "Title": "Annual Leave",
      "StartDate": "/Date(322560000000+0000)/",
      "EndDate": "/Date(322560000000+0000)/",
      "Description": "My leave",
      "LeavePeriods": [
        {
          "NumberOfUnits": 22.8,
          "PayPeriodEndDate": "/Date(322560000000+0000)/",
          "PayPeriodStartDate": "/Date(322560000000+0000)/"
        }
      ],
      "UpdatedDateUTC": "/Date(1583967733054+0000)/"
    }
  ]
}

Changes

No recorded changes to this operation across all 56 revisions of this API.