Deletes an Allowance

delete https://api.factorialhr.com/api/2025-04-01/resources/timeoff/allowances/{id}

Deletes an allowance

Response

Response body

object

integer

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

string

When can the acrrued units be spent.

current_cycle next_cycle

allowance_type

string

required

Sets the allowance units. Can be "days" or "hours"

days hours

available_days

string

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.

all_days generated_days generated_days_monthly generated_days_monthly_first_day monthly_fifteenth mensiversary bimonthly_first_and_fifteenth bimonthly_fifteenth_and_last

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

string

Indicates if the allowance is based on working on calendar days.

working_days natural_days natural_days_only_range french_calendar_days french_ouvres

employee_carry_over_starting_year

integer

When does the carryover start

expire_in_months

integer

When does the carryover expire in months.

frequency

string

Defines duration of the allowance cycles. Can be "yearly", "monthly_flexible" or "lifetime"

monthly_flexible yearly lifetime

holiday_allowance_in_cents

integer

Base amount of holiday allowance units multiplied by 100

leave_type_ids

array of integers

required

An array of leave type ids associated with that allowance

leave_type_ids*

maximum_amount_in_cents

integer

Maximum the allowance can reach on accrued

name

string

required

Allowance name set by the user

negative_counter_type

string

Whether the allowance allows to request more days than available

negative_counter_disabled negative_counter_enabled

position

integer

Indicates the position in the allowance when rendering them in UI

proration_type

string

required

Whether the allowance has proration enabled or not.

proration_enabled proration_disabled

pto_proratio_enabled

boolean

Whether the allowance days are prorrated or not

range_type

string

Configures how leaves duration is handled.

exact_range extra_non_working_days_at_end

rounding

string

required

How the accrued units of the allowance are rounded. It depends if the allowance is set in hours or days.

half_day decimals quarters round_up

send_notification

boolean

source_units

string

This field configures the type of allowance (fixed balance, based on worked time)

base_units overtime_units by_worked_time

tenure_period_transition

string

In case the allowance has tenure periods, when is this tenure applied.

beginning_of_cycle end_of_cycle after_milestone

tenure_periods

array

required

The tenure periods associated with the allowance.

tenure_periods*

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

integer

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

Language

Credentials

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://api.factorialhr.com/api/2025-04-01/resources/timeoff/allowances/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK