Payday

Apply Suggestion

Apply AI suggestion: creates allocation rules and the plan's budgets.

For each suggestion category:

  • Bills → virtual pot rule, and a 'utilities' budget
  • Savings → transfer rule (real money movement)
  • Investments → transfer rule (real money movement)
  • Discretionary → per-category budgets from spending analysis

EQ-72 ruling 4 (13 Oct 2026): this endpoint used to create budgets and OVERWRITE the limits the user had set (the founder's eight budgets were rewritten on 28 Sep). Now:

  • ?mode=propose (the app): no budget is written. Every budget the plan wants is returned in budget_proposals; the app shows them and the user confirms per budget through PATCH /api/budgets/bulk-update.
  • no mode (web app, older phones): today's behaviour, except a user-set limit is never overwritten or deleted — it is skipped and proposed — and a £0 budget is never created. The plan still creates budgets that do not exist, and may resize or remove one only while it is the plan's own: created by the previous Apply and still at the limit that Apply wrote (owned.budget_limits). See _BudgetWrites.
post/api/payday/apply-suggestion

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/apply-suggestion
  • Auth: HTTP bearer

Query parameters

modestring nullable

'propose': budgets are proposed, never written (EQ-72)

Request body

summarystring nullable

Response

Successful Response

budgets_createdinteger required
budgets_updatedinteger required
rules_createdinteger required
rules_updatedinteger
budgets_removedinteger
rules_deactivatedinteger
budgets_proposedinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.