Budget Flow

The Budget Flow report.

For one budget period, the money each account of the chosen types was budgeted to receive or pay and the money that actually went through it, grouped by account type with a total for each. Use it to see how a period's budget compares with what happened in cash terms. In GnuCash: Reports ▸ Budget ▸ Budget Flow.

The options that matter are General/Budget, General/Period (which period, counting from 1) and Accounts/Account. The first column of figures is the budget, the second the actual.

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 Flow"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "Budget Flow: test budget - 03/01/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total:",
                    "…": "…"
                  },
                  {
                    "display": "$20.00",
                    "…": "…"
                  },
                  {
                    "display": "$35.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

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

It prints:

{
  "title": "Budget Flow: test budget - 03/01/24",
  "sections": [
    {
      "blocks": [
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            "…",
            {
              "role": "total",
              "cells": [
                {
                  "text": "Total:",
                  "…": "…"
                },
                {
                  "display": "$20.00",
                  "…": "…"
                },
                {
                  "display": "$35.00",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

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

Result:

{
  "structuredContent": {
    "title": "Budget Flow: test budget - 03/01/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total:",
                    "…": "…"
                  },
                  {
                    "display": "$20.00",
                    "…": "…"
                  },
                  {
                    "display": "$35.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: e6e34fa3b6e748debde3cb3bc76d3e53 · Script: standard/budget-flow.rhai

Options

Accounts

Account (accountList, default []): Report on these accounts.

General

Report name (string, default "Budget Flow"): 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.
Period (numberRange, default 1): Period number.
Price Source (multichoice, default "pricedb-latest"): The source of price information.
Report's currency (currency, default "CURRENCY::USD"): Select the currency to display the values of this report in.