Sign in

v51

latestOpenAPI 3.0.0MITraw.githubusercontent.com2026-07-213287185.4 KB
PayrollAu

Creates a leave application

post/LeaveApplications

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

LeaveApplicationIDstring uuid

The Xero identifier for Payroll Employee

EmployeeIDstring uuid

The Xero identifier for Payroll Employee

LeaveTypeIDstring uuid

The Xero identifier for Leave Type

Titlestring

The title of the leave

StartDatestring

Start date of the leave (YYYY-MM-DD)

EndDatestring

End date of the leave (YYYY-MM-DD)

Descriptionstring

The Description of the Leave

PayOutType'DEFAULT' | 'CASHED_OUT'

How the requested leave will be paid out, e.g. cashed out.

UpdatedDateUTCstring

Last modified timestamp

Example request

[
  {
    "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)/"
  }
]

Response

A successful request

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)/"
    }
  ]
}