EmployeeLeaveType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmployeeLeaveType",
  "title": "EmployeeLeaveType",
  "type": "object",
  "properties": {
    "leaveTypeID": {
      "description": "The Xero identifier for leave type",
      "type": "string",
      "format": "uuid"
    },
    "scheduleOfAccrual": {
      "description": "The schedule of accrual",
      "type": "string",
      "enum": [
        "AnnuallyAfter6Months",
        "OnAnniversaryDate",
        "PercentageOfGrossEarnings",
        "NoAccruals"
      ]
    },
    "unitsAccruedAnnually": {
      "description": "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "typeOfUnitsToAccrue": {
      "description": "The type of units accrued for the leave annually",
      "type": "string"
    },
    "maximumToAccrue": {
      "description": "The maximum number of units that can be accrued for the leave",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "openingBalance": {
      "description": "The initial number of units assigned when the leave was added to the employee",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "openingBalanceTypeOfUnits": {
      "description": "The type of units for the opening balance",
      "type": "string"
    },
    "rateAccruedHourly": {
      "description": "not supported in Payroll NZ",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "percentageOfGrossEarnings": {
      "description": "Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period.",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "includeHolidayPayEveryPay": {
      "description": "Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run.",
      "type": "boolean"
    },
    "showAnnualLeaveInAdvance": {
      "description": "Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip",
      "type": "boolean"
    },
    "annualLeaveTotalAmountPaid": {
      "description": "Specific to Annual Leave. Annual leave balance in dollars",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "scheduleOfAccrualDate": {
      "description": "The date when an employee becomes entitled to their accrual.",
      "type": "string",
      "format": "date",
      "example": "2020-01-19",
      "x-is-date": true
    }
  }
}