Simulate a payment change
simulate_payment_changeCompares a payment scenario with the current forecast, without saving anything.
move gives a visible bill another date, remove leaves it out, add adds a payment in the household
currency. Returns baseline, scenario and persisted: false; the stored bills are unchanged.
Use it when the user names a payment, a date or an amount; the engine's own best move is the what-if
answer of get_household_answers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | ||
| amount | No | ||
| household_id | No | ||
| payment_date | No | ||
| obligation_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||