v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Timeoff > AllowanceStat

Reads all Allowance stats

Retrieves the employee time off counters for a specific allowance with a reference date

get/api/2026-07-01/resources/timeoff/allowance_stats

Query parameters

ids[]string[]

A virtual ID for the allowance stat, composed of employee_id/allowance_id/reference_date. Cannot be used to fetch this resource.

employee_ids[]string[]

Get the allowance stats for specific employees

[
  "1"
]

allowance_ids[]string[]

Filter the stats by these allowance IDs

[
  "1",
  "2"
]

reference_datestring

The reference date to calculate the allowance stats. If not provided, it will use today's date.

Example:2023-10-01

The reference date to calculate the allowance stats. If not provided, it will use today's date.

Response

Example response

{
  "data": [
    {
      "id": "1/2/2023-10-01",
      "allowance_id": "10",
      "employee_id": "42",
      "year": 2025,
      "cycles": [
        {
          "id": "10/2025-01-01/2025-12-31",
          "start_at": "2025-01-01",
          "end_at": "2025-12-31",
          "regular_start_at": "2025-01-01",
          "regular_end_at": "2025-12-31",
          "allowance_id": 10
        }
      ],
      "cycle_carry_overs": [
        {
          "from_cycle_ending_on": "2024-12-31",
          "expire_in_months": 3,
          "non_expire": false,
          "total": "5.0",
          "used": [
            {
              "date": "2024-06-15",
              "amount": "1.0"
            }
          ],
          "accumulated": "5.0",
          "expired": "0.0",
          "taken": "2.0"
        }
      ],
      "accumulated_carry_over": "3.5",
      "available_days": "8.0",
      "total_accrued_units": "15.0",
      "total": "19.0",
      "incidences": "1.0",
      "accrued_incidences": "0.5",
      "available_incidences": "0.5",
      "max_balance_cap": "25.0",
      "policy_allowance": "20.0",
      "prorated_allowance_days": "18.5",
      "total_in_decimal": "20.0",
      "used_carry_over": "1.5",
      "used_days": "7.0",
      "used_units_until_reference_date": "6.5",
      "outstanding_units": "2.0"
    }
  ]
}