--- title: "Reads all Allowances" method: GET path: "/api/2026-10-01/resources/timeoff/allowances" tags: ["Timeoff > Allowance"] --- # Reads all 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: one of: - OAuth 2 - Authorization code: `https://id.factorialhr.com/oauth/authorize` - Token URL: `https://id.factorialhr.com/api/oauth/token` scopes: `time_off` - API key in header `x-api-key` Retrieves allowances ## Query parameters - `ids[]` string[]: Return only the allowances with these ids. - `timeoff_policy_id` string: Return only the allowances belonging to this time-off policy. It takes one id, not a list. - `by_overtime` boolean: 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. ## Response `200` OK - object - `data` TimeoffAllowance[] - `id` string, required: Unique identifier of the allowance - `accrued_denominator_in_cents` integer: Only for Allowances based on worked time. It represents how many units you need to work to be granted allowance units - `accrued_factor_in_cents` integer: Only for Allowances based on worked time. It represents how many units you are given per unit of time worked - `accrued_units_availability` 'current_cycle' | 'next_cycle': When can the acrrued units be spent. - `allowance_type` 'days' | 'hours', required: Sets the allowance units. Can be "days" or "hours" - `available_days` 'all_days' | 'generated_days' | 'generated_days_monthly' | 'generated_days_monthly_first_day' | 'monthly_fifteenth' | 'mensiversary' | 'bimonthly_first_and_fifteenth' | 'bimonthly_fifteenth_and_last', required: Indicates how the allowance units are accrued. For example all_days means all allowance days are given on the first day of the cycle. - `carry_over_days` integer: How many units can carry over between cycles - `carry_over_units_in_cents` integer: How many units can carry over between cycles multiplied by 100 - `count_holiday_as_workable` boolean, required: This setting flags if units taken during a bank holiday should be deducted or not from allowance. - `cycle_length` integer: How many months does each allowance cycle last - `cycle_start` string: When does the cycle start. - `days_type` 'working_days' | 'natural_days' | 'natural_days_only_range' | 'french_calendar_days' | 'french_ouvres': Indicates if the allowance is based on working on calendar days. - `employee_carry_over_starting_year` integer: When does the carryover start - `expire_in_months` integer: When does the carryover expire in months. - `frequency` 'monthly_flexible' | 'yearly' | 'lifetime': Defines duration of the allowance cycles. Can be "yearly", "monthly_flexible" or "lifetime" - `holiday_allowance_in_cents` integer: Base amount of holiday allowance units multiplied by 100 - `leave_type_ids` string[], required: An array of leave type ids associated with that allowance - `maximum_amount_in_cents` integer: Maximum the allowance can reach on accrued - `name` string, required: Allowance name set by the user - `negative_counter_type` 'negative_counter_disabled' | 'negative_counter_enabled': Whether the allowance allows to request more days than available - `position` integer: Indicates the position in the allowance when rendering them in UI - `proration_type` 'proration_enabled' | 'proration_disabled', required: Whether the allowance has proration enabled or not. - `pto_proratio_enabled` boolean: Whether the allowance days are prorrated or not - `range_type` 'exact_range' | 'extra_non_working_days_at_end': Configures how leaves duration is handled. - `rounding` 'half_day' | 'decimals' | 'quarters' | 'round_up', required: How the accrued units of the allowance are rounded. It depends if the allowance is set in hours or days. - `send_notification` boolean: Whether employees are notified when the allowance changes - `source_units` 'base_units' | 'overtime_units' | 'by_worked_time': This field configures the type of allowance (fixed balance, based on worked time) - `tenure_period_transition` 'beginning_of_cycle' | 'end_of_cycle' | 'after_milestone': In case the allowance has tenure periods, when is this tenure applied. - `tenure_periods` object[], required: The tenure periods associated with the allowance. - `id` string, required - `period_type` 'months' | 'years', required - `period_length` integer - `adjustment_in_cents` integer - `balance_type` 'fixed_balance' | 'time_worked_based', required - `time_worked_based_hours_accrued_in_cents` integer - `time_worked_based_per_hours_worked_in_cents` integer - `max_cap_in_cents` integer - `tenure_periods_enabled` boolean: Whether the allowance has tenure periods enabled or not. - `timeoff_cycle` string, required: Value to indicate how the allowance cycle is configured. Its an abbreviation of the first and last month. - `timeoff_policy_id` string, required: The Id of the policy to which the allowance belongs to - `unlimited_accrued_hours` boolean: Flag to indicate if there is unlimited accrual. - `unlimited_carry_over` boolean: Flag to indicate if there is unlimited carry over. - `unlimited_carry_over_expiration` boolean: Boolean to flag if carryover does not expire - `unlimited_holidays` boolean: Flag to indicate that the allowance has unlimited available days - `meta` PagedIndexMeta - `start_cursor` string - `end_cursor` string - `has_previous_page` boolean, required - `has_next_page` boolean, required - `limit` integer, required - `total` integer, required ## Changes - **2026-11-03** `83ac9aa1de50`: 1 info - endpoint added [Operation history](https://skmtc.dev/factorialhr/apis/factorial-api/changes/api/2026-10-01/resources/timeoff/allowances/get.md) --- [API](https://skmtc.dev/factorialhr/apis/factorial-api.md) - [All operations](https://skmtc.dev/factorialhr/apis/factorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/factorialhr/apis/factorial-api/revisions/83ac9aa1de50?raw)