Read a budget month
const url = 'https://example.com/api/v1/money/budgets/example/months/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/money/budgets/example/months/example \ --header 'Authorization: Bearer <token>'Return the budget view for the requested month. The view includes Ready to Assign, each Category’s Assignment and Available values, and the month’s activity. This read does not create a month file. Route: /api/v1/money/budgets/{budget_id}/months/{month}. Inputs: budget_id, month. Safe reads can use bounded retries.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Budget ID
Month YYYY-MM
Responses
Section titled “Responses”The budget table for one month
The budget table for one month.
object
Sum of Activity over all shown categories.
Sum of Assigned over all shown categories.
Sum of Available over all shown categories.
Budget ID.
Budget name.
Budget currency.
Groups in file order (expense and payment categories only).
A category group (a ## heading) with its categories and totals.
object
Sum of Activity.
Sum of Assigned.
Sum of Available.
Categories in file order.
A category’s numbers in one month.
object
Activity in this month.
Assigned in this month.
Available at the end of this month.
For a payment Category, the Card account it pays.
True when visibility:: is not visible.
Category ID.
expense or payment (a Card payment Category).
Full target months covered by Available.
Display name.
available, funded, overspent, underfunded or funded_ahead.
The funding label for the state, for example Funded for next 2 months.
Monthly target, if any.
Available beyond the full target months.
Group name.
Income and opening-balance categories: a transaction in one of them adds to Ready to Assign (the “Inflow: Ready to Assign” Category; DESIGN §48; #931).
A category whose inflows go to Ready to Assign.
object
Category ID.
Display name.
Month YYYY-MM.
Categories that are overspent or underfunded.
Ready to Assign, or Assigned more than you have below zero.
Ready to Assign at the end of the month.
Ordered source generation; file replacements also advance it. Clients keep the greatest (#984).
Decimal places of currency.
Examplegenerated
{ "activity": 1, "assigned": 1, "available": 1, "budget_id": "example", "budget_name": "example", "currency": "example", "groups": [ { "activity": 1, "assigned": 1, "available": 1, "categories": [ { "activity": 1, "assigned": 1, "available": 1, "card_account_id": "example", "hidden": true, "id": "example", "kind": "example", "months_funded": 1, "name": "example", "state": "example", "state_label": "example", "target": 1, "target_remainder": 1 } ], "name": "example" } ], "inflow_categories": [ { "id": "example", "name": "example" } ], "month": "example", "overspent_count": 1, "ready_label": "example", "ready_to_assign": 1, "revision": 1, "scale": 1}The standard API error response: { "error": { ... } }.
object
Example
{ "error": { "code": "bad_request" }}The standard API error response: { "error": { ... } }.
object
Example
{ "error": { "code": "bad_request" }}The budget files break a Money rule
The standard API error response: { "error": { ... } }.
object
Example
{ "error": { "code": "bad_request" }}