latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

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.

locale'en' | 'de' | 'fr' | 'hu' | 'it' | 'pl' | 'pt' | 'ru' | 'es' | 'tr' | 'uk'

Returns translatable names in this language, falling back to the stored name where no translation exists. Omit it to keep the response unchanged.

Response

Successful response

idstring required

namestring required

Translated into locale when one is given, otherwise into the API key owner's language, falling back to the stored name where no translation exists.

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