Payday

Get Payday Suggestion

Get allocation suggestion enriched with goals and budget performance.

Once the user has ACCEPTED a coach plan, the accepted plan is echoed back unchanged (accepted=True) for the rest of the current pay cycle — it is not regenerated on every fetch. A fresh suggestion is produced again after the next payday has passed, so the plan updates once per cycle rather than every time the tab opens.

get/api/payday/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/suggestion
  • Auth: HTTP bearer

Response

Successful Response

summarystring required
next_paydaystring required
monthly_incomenumber required
total_allocatednumber required
remainingnumber required
acceptedboolean
income_staleboolean
one_off_income_this_cyclenumber
incoming_this_cyclenumber
usual_spendingnumber

Changes

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