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.
Authorizations
Path Parameters
^([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)$Body
10 <= x <= 11Allowance amount per accrual cycle. For hour-based allowance types the value is in MINUTES (e.g. 480 = 8 hours).
-100000 <= x <= 100000month, year, biweek ^\d{4}-\d{2}-\d{2}$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.
1 <= x <= 1200How 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.
month, day 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.
0 <= x <= 100000How long carried-forward allowance stays usable in the new fiscal year. null = it never expires; N (>= 1) = months after fiscal year end.
1 <= x <= 1200Amount surviving permanently after the expiry deadline. Requires carry_forward_expiry_months; must be lower than max_carry_forward when both are set.
0 <= x <= 100000Why this rule is being changed — stored in the rule audit log.
3 - 500Response
Successful response