Report

Budget Chart

The Budget Chart report.

One bar chart for each of the selected accounts, comparing the budgeted and the actual amount in each budget period. Use it to see at a glance which accounts are on track. The charts show the account's name and its totals for the whole budget in their title. In GnuCash: Reports ▸ Budget ▸ Budget Chart.

The options that matter are General/Budget, Accounts/Accounts and Levels of Subaccounts, the range of periods (General/Range start and Range end) and Display/Running Sum, which charts running totals instead of each period.

Examples

Example: with a copy of the reports/budget example book open as book.gnucash, at 2024-03-15T12:00:00Z.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"report.run","params":{"report":"Budget Chart"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "Budget Chart",
    "sections": [
      {
        "blocks": [
          {
            "kind": "chart",
            "type": "bar",
            "title": [
              "Bank",
              "Bgt: $120.00 Act: $159.00"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash report.run '{"report":"Budget Chart"}'

It prints:

{
  "title": "Budget Chart",
  "sections": [
    {
      "blocks": [
        {
          "kind": "chart",
          "type": "bar",
          "title": [
            "Bank",
            "Bgt: $120.00 Act: $159.00"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Budget Chart"}}

Result:

{
  "structuredContent": {
    "title": "Budget Chart",
    "sections": [
      {
        "blocks": [
          {
            "kind": "chart",
            "type": "bar",
            "title": [
              "Bank",
              "Bgt: $120.00 Act: $159.00"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: 415cd38d39054d9e9c4040455290c2b1 · Script: standard/budget-barchart.rhai

Options

Accounts

  • Accounts (accountList, default []): Report on these accounts.
  • Levels of Subaccounts (multichoice, default 6): Maximum number of levels in the account tree displayed.

Display

  • Running Sum (boolean, default true): Calculate as running sum?
  • Chart Type (multichoice, default "bars"): Select which chart type to use.
  • Plot Width (plotSize, default {"percent":100}): Width of plot, 10 - 100 in percent, above in pixels.
  • Plot Height (plotSize, default {"percent":100}): Height of plot, 10 - 100 in percent, above in pixels.

General

  • Report name (string, default "Budget Chart"): Enter a descriptive name for this report.
  • Stylesheet (multichoice, default "Default"): Select a stylesheet for the report.
  • Add options summary (multichoice, default "never"): Add summary of options.
  • Budget (budget, default null): Budget to use.
  • Range start (multichoice, default "current"): Select a budget period type that starts the reporting range.
  • Exact start period (numberRange, default 1): Select exact period that starts the reporting range.
  • Range end (multichoice, default "next"): Select a budget period type that ends the reporting range.
  • Exact end period (numberRange, default 1): Select exact period that ends the reporting range.