Budgets

Get Budget Health

Calculate overall budget health score (0-100) with grade and summary.

get/api/budgets/health-summary

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/budgets/health-summary
  • Auth: HTTP bearer

Response

Successful Response

health_scoreinteger required
gradestring required
budgets_exceededinteger required
budgets_on_trackinteger required
worst_budgetobject nullable
best_budgetobject nullable
total_budgetnumber required
total_spentnumber required
reimbursables_totalnumber required
ai_summarystring required
monthly_trendstring required

Changes

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