Evenbead docs
Contents

Budgets

5 operations. All areas

POST/v1/budgets

Create a monthly P&L budget for a fiscal year (whole company, one class or one project): by hand (12 months or an annual amount spread evenly per account) or from last fiscal year's actuals with a percentage change. Audited; dry_run previews.

  • Operation createBudget
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • name string, required
  • fiscal_year integer, required Named by the calendar year it ends in
  • class string Budget one class
  • project string Budget one project
  • method "manual" | "actuals"
  • percent_change number | string From actuals: the change applied to last year's amounts, in percent (two decimals at most)
  • lines array of object
  • dry_run boolean
Responses
  • 200 Dry run (object)
  • 201 Created (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/budgets

Budgets with their totals

  • Operation listBudgets
  • Scope: read
  • Read
Parameters
  • fiscal_year query, integer
  • status query, "active" | "archived"
Responses
  • 200 Budgets (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/budgets/{id}

A budget with its monthly amounts per account

  • Operation getBudget
  • Scope: read
  • Read
Parameters
  • id path, string, required
Responses
  • 200 Budget (object)
  • Errors 400, 401, 403, 404, 429, 500 (Error: error.type, message)

POST/v1/budgets/{id}

Rename a budget, or archive it (an archived budget does not change) or make it active again

  • Operation updateBudget
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • name string
  • status "active" | "archived"
  • dry_run boolean
Responses
  • 200 Updated (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/budgets/{id}/lines

Set the monthly amounts of some accounts (others keep theirs; zeros clear one). Audited with what changed; dry_run previews.

  • Operation setBudgetLines
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • lines array of object, required
  • dry_run boolean
Responses
  • 200 Updated (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)