Sign in
Allowance Management

Create an allowance type

Creates an allowance type. It starts without a rule, so nothing accrues on it until you create one via POST /allowance-types/{allowance_type_id}/rules. How many types a workspace may have depends on its plan.

post/allowance-types

Request body

namestring required
allowance_unit'days' | 'hours' required

Whether this type is counted in days or in minutes. Cannot be changed afterwards.

ignore_allowance_limitboolean

When true, members may book more than their balance and go negative.

Response

Successful response

idstring required
namestring required

Translated into the API key owner's language when a translation exists, otherwise the stored name.

default_namestring required

The stored name, without any translation applied.

allowance_unit'days' | 'hours' required

Whether this type is counted in days or in minutes.

ignore_allowance_limitboolean required

When true, members may book more than their balance and go negative.

default_rule_idstring nullable required

The rule a new member of this workspace is put on. A department default rule takes precedence over it.

workspace_idstring required
createdAtstring required
updatedAtstring required

Changes