Payday
Virtual Allocate
Process virtual pot allocations on payday.
For each rule linked to a budget category:
- Find the matching budget for the current user. PIS-off savings / investments rules arrive without a budget row: that tracking row is created. With ?mode=propose a SPENDING category with no budget is not created here — the rule comes back as "needs_budget" and the user confirms the budget from the proposal the rules PUT returned (EQ-72 ruling 4). An older client gets the budget created as before.
- Reset period_start_date to today (new period)
- Mark virtual_pot_funded_at = now
- Return confirmation
monthly_limit is never changed here. No money moves — this is purely tracking.
post/api/payday/virtual-allocate
Request
- Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
- URL: https://api.earmarkiq.app/api/payday/virtual-allocate
- Auth: HTTP bearer
Query parameters
modestring nullable
'propose': budgets are proposed, never written (EQ-72)
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 2 revisions of this API.