Creates an Allowance

post

https://api.factorialhr.com/api/2025-10-01/resources/timeoff/allowances

Creates a new Time off allowance

Body Params

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

enum

required

When can the accrued units be spent.

Allowed:

allowance_type

string

enum

required

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

Allowed:

available_days

string

enum

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_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

enum

required

When does the cycle start.

days_type

string

enum

required

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

Allowed:

expire_in_months

integer

When does the carryover expire in months.

frequency

string

enum

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

Allowed:

holiday_allowance_in_cents

integer

required

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

enum

required

Whether the allowance allows to request more days than available.

Allowed:

position

integer

Indicates the position in the allowance when rendering them in UI

proration_type

string

enum

required

Whether the allowance has proration enabled or not.

Allowed:

pto_proratio_enabled

boolean

required

Whether the allowance days are prorated or not

range_type

string

enum

Configures how leaves duration is handled.

Allowed:

rounding

string

enum

required

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

Allowed:

source_units

string

enum

required

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

Allowed:

tenure_period_transition

string

enum

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

Allowed:

tenure_periods_enabled

boolean

Whether the allowance has tenure periods enabled or not.

tenure_periods

array

required

The tenure periods associated with the allowance.

tenure_periods*

timeoff_policy_id

integer

required

The Id of the policy to which the allowance belongs to

unlimited_accrued_hours

boolean

required

Flag to indicate if there is unlimited accrual.

unlimited_carry_over

boolean

required

Flag to indicate if there is unlimited carry over.

unlimited_carry_over_expiration

boolean

required

Boolean to flag if carryover does not expire

unlimited_holidays

boolean

required

Flag to indicate that the allowance has unlimited available days

Response

201CREATED