Budget Income Statement

The Budget Income Statement report.

The income statement for a budget: the budgeted revenue and expenses over the budget's periods, with the net income the budget would give. Use it to see what the budget plans to earn and spend. It has the same figures as the Budget Profit & Loss, which GnuCash offers under both names. In GnuCash: Reports ▸ Budget ▸ Budget Income Statement.

The options that matter are General/Budget and, with General/Report for range of budget periods, General/Range start and Range end; the rest are those of the Income Statement.

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 Income Statement"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": " Budget Income Statement for Budget test budget",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Revenue",
                    "…": "…"
                  },
                  {
                    "display": "$195.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

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

It prints:

{
  "title": " Budget Income Statement for Budget test budget",
  "sections": [
    {
      "blocks": [
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            "…",
            {
              "role": "total",
              "cells": [
                {
                  "text": "Total Revenue",
                  "…": "…"
                },
                {
                  "display": "$195.00",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Budget Income Statement"}}

Result:

{
  "structuredContent": {
    "title": " Budget Income Statement for Budget test budget",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Revenue",
                    "…": "…"
                  },
                  {
                    "display": "$195.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: 583c313fcc484efc974c4c844404f454 · Script: standard/budget-income-statement.rhai

Options

Accounts

Accounts (accountList, default []): Report on these accounts, if display depth allows.
Levels of Subaccounts (multichoice, default 3): Maximum number of levels in the account tree displayed.
Flatten list to depth limit (boolean, default false): Displays accounts which exceed the depth limit at the depth limit.

Commodities

Report's currency (currency, default "CURRENCY::USD"): Select the currency to display the values of this report in.
Price Source (multichoice, default "pricedb-nearest"): The source of price information.
Show Foreign Currencies (boolean, default true): Display any foreign currency amount in an account.
Show Exchange Rates (boolean, default false): Show the exchange rates used.

Display

Include accounts with zero total balances (boolean, default true): Include accounts with zero total (recursive) balances in this report.
Omit zero balance figures (boolean, default false): Show blank space in place of any zero balances which would be shown.
Parent account balances (multichoice, default "immediate-bal"): How to show the balances of parent accounts. * Account Balance in the parent account, excluding any subaccounts. * Do not show any balances of parent accounts.
Parent account subtotals (multichoice, default "f"): How to show account subtotals for parent accounts. * Show subtotals for selected parent accounts which have subaccounts. * Do not show any subtotals for parent accounts.
Display accounts as hyperlinks (boolean, default true): Shows each account in the table as a hyperlink to its register window.
Show accounting-style rules (boolean, default false): Use rules beneath columns of added numbers like accountants do.
Label the revenue section (boolean, default true): Whether or not to include a label for the revenue section.
Include revenue total (boolean, default true): Whether or not to include a line indicating total revenue.
Label the expense section (boolean, default true): Whether or not to include a label for the expense section.
Include expense total (boolean, default true): Whether or not to include a line indicating total expense.
Display as a two column report (boolean, default false): Divides the report into an income column and an expense column.
Display in standard, income first, order (boolean, default true): Causes the report to display in the standard order, placing income before expenses.

General

Report name (string, default "Budget Income Statement"): 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.
Report Title (string, default "Budget Income Statement"): Title for this report.
Budget (budget, default null): Budget to use.
Report for range of budget periods (boolean, default false): Create report for a budget period range instead of the entire budget.
Range start (numberRange, default 1): Select a budget period that begins the reporting range.
Range end (numberRange, default 1): Select a budget period that ends the reporting range.