Settlement steps
A settlement policy is a pipeline of steps that run in order at the end of each period. The steps fall into three groups:
- Crediting steps add earned time to the account — plain flex, or an expression that combines several counters at different rates.
- Cap and payout steps then adjust the result — capping the balance, forfeiting or paying out the surplus, or paying a requested withdrawal.
- Threshold and transfer steps move balance between accounts — pre-paying a recurring threshold, or transferring the balance elsewhere.
List crediting steps before cap and payout steps, so the caps act on the freshly credited balance.
Crediting steps
Bank the period’s worked − expected delta, optionally scaled
Bank an amount computed from the input aliases and the built-in delta
Cap and payout steps
Cap the balance at the employee’s average weekly norm
Forfeit balance above a fixed ceiling at every settlement
Forfeit balance above a ceiling at each period cut-off
Pay out the amount the employee requested at submit time
Pay out the remaining balance at each period end