Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Timeoff > Allowance

Reads a single Allowance

Retrieves allowances

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

Path parameters

idstring required

An array of allowance ids to look for

Response

OK

idstring required

Unique identifier of the allowance

accrued_denominator_in_centsinteger

Only for Allowances based on worked time. It represents how many units you need to work to be granted allowance units

accrued_factor_in_centsinteger

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_daysinteger

How many units can carry over between cycles

carry_over_units_in_centsinteger

How many units can carry over between cycles multiplied by 100

count_holiday_as_workableboolean required

This setting flags if units taken during a bank holiday should be deducted or not from allowance.

cycle_lengthinteger

How many months does each allowance cycle last

cycle_startstring

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_yearinteger

When does the carryover start

expire_in_monthsinteger

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_centsinteger

Base amount of holiday allowance units multiplied by 100

leave_type_idsstring[] required

An array of leave type ids associated with that allowance

maximum_amount_in_centsinteger

Maximum the allowance can reach on accrued

namestring 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

positioninteger

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_enabledboolean

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_notificationboolean
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_enabledboolean

Whether the allowance has tenure periods enabled or not.

timeoff_cyclestring required

Value to indicate how the allowance cycle is configured. Its an abbreviation of the first and last month.

timeoff_policy_idstring required

The Id of the policy to which the allowance belongs to

unlimited_accrued_hoursboolean

Flag to indicate if there is unlimited accrual.

unlimited_carry_overboolean

Flag to indicate if there is unlimited carry over.

unlimited_carry_over_expirationboolean

Boolean to flag if carryover does not expire

unlimited_holidaysboolean

Flag to indicate that the allowance has unlimited available days

Example response

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