Allowance Management

Update an allowance rule

Updates an existing allowance rule. Only provide the fields you want to change. Changes are applied to all members subscribed to this rule.

patch/rules/{id}

Path parameters

idstring uuid required

Request body

namestring

accrual_monthinteger

rule_amountnumber

Allowance amount per accrual cycle. For hour-based allowance types the value is in MINUTES (e.g. 480 = 8 hours).

accrual_cycle'month' | 'year' | 'biweek'

accrual_anchor_datestring nullable

cycle_on_employment_startboolean

rule_durationinteger nullable

Per-accrual rolling expiry in months (each accrual valid this many months from its accrual date). Min 1; null = off. Cannot be combined with any carry-forward setting, and is not allowed on a 0-amount (manual) rule.

upfront_allocationboolean

proration_basis'month' | 'day'

How partial yearly rules are prorated. month = whole months count fully, the partial start or end month is prorated by day; day = calendar-day exact. Ignored for monthly and biweekly cycles. Defaults to month.

max_carry_forwardnumber nullable

Hard cap on the amount carried into the next fiscal year, applied at the year boundary. null = unlimited (everything carries), 0 = nothing carries. For hour-based allowance types the value is in MINUTES.

carry_forward_expiry_monthsinteger nullable

How long carried-forward allowance stays usable in the new fiscal year. null = it never expires; N (>= 1) = months after fiscal year end.

carry_forward_kept_after_expirynumber nullable

Amount surviving permanently after the expiry deadline. Requires carry_forward_expiry_months; must be lower than max_carry_forward when both are set.

reasonstring

Why this rule is being changed — stored in the rule audit log.

Response

Successful response

countnumber required