FAfactorialhr
Timeoff > Allowance

Reads all Allowances

Changed on

Retrieves allowances

get/api/2026-10-01/resources/timeoff/allowances

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/allowances
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_off
    • or API key in header x-api-key

Query parameters

ids[]string[]

Return only the allowances with these ids.

[
  "1",
  "2"
]
timeoff_policy_idstring

Return only the allowances belonging to this time-off policy. It takes one id, not a list.

Example:1
by_overtimeboolean

Set to true to return only the allowances funded by overtime hours, leaving out those accrued from a base entitlement or from worked time. Passing false has no effect.

Example:true

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "accrued_denominator_in_cents": 1000,
      "accrued_factor_in_cents": 10,
      "accrued_units_availability": "current_cycle",
      "allowance_type": "days",
      "available_days": "all_days",
      "carry_over_days": 15,
      "carry_over_units_in_cents": 1500,
      "cycle_length": 12,
      "cycle_start": "jan",
      "days_type": "working_days",
      "employee_carry_over_starting_year": 1,
      "expire_in_months": 6,
      "frequency": "yearly",
      "holiday_allowance_in_cents": 2300,
      "leave_type_ids": [
        "1",
        "2",
        "3",
        "4"
      ],
      "maximum_amount_in_cents": 2800,
      "name": "Holiday Allowance",
      "negative_counter_type": "negative_counter_disabled",
      "proration_type": "proration_enabled",
      "range_type": "working_days",
      "rounding": "half_day",
      "source_units": "base_units",
      "tenure_period_transition": "beginning_of_cycle",
      "tenure_periods": [
        {
          "id": 1,
          "period_type": "years",
          "period_length": 1,
          "adjustment_in_cents": 100,
          "max_cap_in_cents": 100,
          "time_worked_based_hours_accrued_in_cents": 100,
          "time_worked_based_per_hours_worked_in_cents": 100,
          "balance_type": "fixed_balance"
        }
      ],
      "timeoff_cycle": "jan_dec",
      "timeoff_policy_id": "1"
    }
  ]
}

Changes