Hold funds for next month
hold_for_next_monthSet aside this month's leftover budget money for next month. The amount adds to any existing reserve and is capped by the available surplus.
Instructions
Hold some of this month’s leftover "to budget" money back for next month, in integer cents.
This ADDS to whatever is already held for that month — it does not replace it, so calling twice with 1000 leaves 2000 held. To correct a hold, call reset_budget_hold first.
The amount is clamped to what is actually available, so the hold can be smaller than you asked for. Read heldAmount (how much the buffer really grew) and forNextMonth (the resulting total) rather than assuming the request landed in full; held: false means there was no surplus to hold at all.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | Yes | Month whose surplus to hold, as YYYY-MM. | |
| amount | Yes | Amount to hold back, in cents. |