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}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

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
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
createdAt
string
required
updatedAt
string
required
_count
object
required