Forecast

Get Cash Flow Forecast

Generate a 30-day cash flow forecast with daily balance projections, risk assessment, upcoming bills, and an AI-generated summary. Results are cached for 24 hours unless force=true.

get/api/forecast/cash-flow/{user_id}

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/forecast/cash-flow/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idstring uuid required

Query parameters

forceboolean

Force re-generation, skipping cache

Response

Successful Response

statusstring
current_balancenumber required
total_recurring_incomenumber required
total_recurring_expensesnumber required
ai_summarystring nullable required

Changes

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