Xero · Schema

LeaveLine

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
LeaveTypeID string Xero leave type identifier
CalculationType object
EntitlementFinalPayPayoutType object
EmploymentTerminationPaymentType object
IncludeSuperannuationGuaranteeContribution boolean amount of leave line
IsQualifyingEarnings boolean Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settin
NumberOfUnits number Number of units for leave line.
AnnualNumberOfUnits number Hours of leave accrued each year
FullTimeNumberOfUnitsPerPeriod number Normal ordinary earnings number of units for leave line.
View JSON Schema on GitHub

JSON Schema

xero-leaveline-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LeaveLine",
  "title": "LeaveLine",
  "type": "object",
  "properties": {
    "LeaveTypeID": {
      "description": "Xero leave type identifier",
      "type": "string",
      "format": "uuid",
      "example": "742998cb-7584-4ecf-aa88-d694f59c50f9"
    },
    "CalculationType": {
      "$ref": "#/components/schemas/LeaveLineCalculationType"
    },
    "EntitlementFinalPayPayoutType": {
      "$ref": "#/components/schemas/EntitlementFinalPayPayoutType"
    },
    "EmploymentTerminationPaymentType": {
      "$ref": "#/components/schemas/EmploymentTerminationPaymentType"
    },
    "IncludeSuperannuationGuaranteeContribution": {
      "description": "amount of leave line",
      "type": "boolean",
      "example": true
    },
    "IsQualifyingEarnings": {
      "description": "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings",
      "type": "boolean",
      "example": true
    },
    "NumberOfUnits": {
      "description": "Number of units for leave line.",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 2.5
    },
    "AnnualNumberOfUnits": {
      "description": "Hours of leave accrued each year",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 2.5
    },
    "FullTimeNumberOfUnitsPerPeriod": {
      "description": "Normal ordinary earnings number of units for leave line.",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 2.5
    }
  }
}