Absence.io · Schema

Allowance

An employee leave allowance record for a specific reason type and year.

AbsencesEmployeesLeave ManagementHR

Properties

Name	Type	Description
_id	string	Unique identifier of the allowance.
userId	string	ID of the user this allowance belongs to.
reasonId	string	ID of the absence reason type this allowance is for.
year	integer	Calendar year this allowance applies to.
allowance	number	Total number of days allowed.
used	number	Number of days used.
remaining	number	Number of days remaining.
carryover	number	Number of days carried over from the previous year.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/absence-io/refs/heads/main/json-schema/allowance-schema.json",
  "title": "Allowance",
  "description": "An employee leave allowance record for a specific reason type and year.",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Unique identifier of the allowance.",
      "example": "500234"
    },
    "userId": {
      "type": "string",
      "description": "ID of the user this allowance belongs to.",
      "example": "500456"
    },
    "reasonId": {
      "type": "string",
      "description": "ID of the absence reason type this allowance is for.",
      "example": "500789"
    },
    "year": {
      "type": "integer",
      "description": "Calendar year this allowance applies to.",
      "example": 2025
    },
    "allowance": {
      "type": "number",
      "description": "Total number of days allowed.",
      "example": 25
    },
    "used": {
      "type": "number",
      "description": "Number of days used.",
      "example": 10
    },
    "remaining": {
      "type": "number",
      "description": "Number of days remaining.",
      "example": 15
    },
    "carryover": {
      "type": "number",
      "description": "Number of days carried over from the previous year.",
      "example": 0
    }
  }
}