Budgets

Create Budget

Create a spending budget for a category.

post/api/budgets

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

Request body

client_idstring uuid nullable
categorystring required
period'weekly' | 'monthly' | 'annual' | 'custom'
period_start_datestring date nullable
period_end_datestring date nullable
shared_with_partnerboolean
rollover_enabledboolean
budget_typestring
income_percentagenumber nullable
payday_cycleboolean

Response

Successful Response

idstring required
categorystring required
monthly_limitnumber required
periodstring required
current_spendnumber required
remainingnumber required
utilisation_pctnumber required
period_startstring required
period_start_datestring nullable
period_end_datestring nullable
shared_with_partnerboolean
partner_spendnumber
budget_typestring
dismissedboolean
rollover_enabledboolean
rollover_amountnumber
limit_modestring
income_percentagenumber nullable
payday_cycleboolean
effective_limitnumber
pot_categorystring
created_atstring required
updated_atstring required

Changes

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