Skip to main content
GET
List all rules for an allowance type

Authorizations

X-API-KEY
string
header
required

Path Parameters

allowance_type_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

id
string
required
name
string
required
accrual_month
number
required
rule_amount
number
required
accrual_cycle
enum<string>
required
Available options:
month,
year,
biweek
accrual_anchor_date
string | null
required
cycle_on_employment_start
boolean
required
rule_duration
number | null
required
upfront_allocation
boolean
required
proration_basis
enum<string>
required
Available options:
month,
day,
full_month,
none
part_time_basis
enum<string>
required

Scales every grant of this rule to the member's own working week. none = off; workdays = by the days worked per week; hours = by the hours worked per week. A member with no schedule of their own counts as full time.

Available options:
none,
workdays,
hours
part_time_reference
number | null
required

Days (workdays) or hours (hours) per week that count as full time. Required and greater than 0 when part_time_basis is not none; stored as null when it is none.

part_time_from
string | null
required

First day (inclusive) the scaling applies to. A grant for a year, month or two weeks that started earlier is not scaled. Null when part_time_basis is none.

allowance_type_id
string
required
max_carry_forward
number | null
required
carry_forward_expiry_months
number | null
required
carry_forward_kept_after_expiry
number | null
required
carry_negative_balance
boolean
required

Whether a negative balance (more taken than granted) is carried into the next year. false = from the next year change on, the carry-over starts at 0 instead of the debt; positive carry-over keeps following the carry-forward settings. The server sets the period from the next year change, and year changes that already happened stay as they are.

negative_balance_reset_from
string | null
required

First year change (the first day of a new year of this rule) at which a negative balance is no longer carried. Read-only: set by the server when carry_negative_balance becomes false. Null when it was never switched off.

negative_balance_reset_until
string | null
required

First year change at which negative balances are carried again after having been switched off. Read-only: set by the server when carry_negative_balance becomes true again. Null while the setting is off or was never switched off.

createdAt
string
required
updatedAt
string
required
_count
object
required