Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Timeoff > AllowanceStat

Reads a single Allowance stat

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

get/api/2026-07-01/resources/timeoff/allowance_stats/{id}

Path parameters

idstring required

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

Response

OK

idstring required

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

allowance_idstring required

ID of the allowance these stats belong to.

employee_idstring required

ID of the employee these stats belong to.

yearinteger required

Calendar year used to scope cycle calculations.

accumulated_carry_overstring required

Total carried over units accumulated from previous cycles.

available_daysstring required

Remaining usable allowance units at the reference date, after usage, carry-over, and incidence adjustments.

total_accrued_unitsstring required

Total accrued/generated allowance units up to the reference date.

totalstring required

Total entitlement for the cycle used by the Total row in counters (accrued + carry over + incidences, with backend cap/rounding rules applied before incidences).

incidencesstring required

Sum of incidence units (adjustments) applied to this allowance.

accrued_incidencesstring required

Sum of incidence units scoped to 'accrued' target balance for the current cycle, filtered by cycle coverage rules.

available_incidencesstring required

Sum of incidence units scoped to non-accrued target balances for the current cycle, filtered by cycle coverage rules.

max_balance_capstring

Maximum balance cap enforced by policy (null if unlimited or no cap).

policy_allowancestring required

Base policy entitlement for the cycle in allowance units (days or hours depending on allowance setup), before proration and adjustments.

prorated_allowance_daysstring required

Allowance days after proration based on employee tenure or configuration.

total_in_decimalstring

Total allowance units in decimal form (null if not computed for the reference date yet).

used_carry_overstring required

Units from carry over already consumed.

used_daysstring required

Total used days (converted from units) up to the reference date.

used_units_until_reference_datestring required

Units consumed strictly until the given reference date (excludes future approved leaves).

outstanding_unitsstring required

Pending units scheduled (approved in the future) not yet counted as used until the reference date.

Example response

{
  "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"
}