Report

Budget Balance Sheet

The Budget Balance Sheet report.

The balance sheet as it would be at the end of a budget's last period if the budget came true: the real balances plus the budget's amounts. Assets are split into existing, allocated (what the budget adds) and unallocated. Use it to see where a budget would leave you. In GnuCash: Reports ▸ Budget ▸ Budget Balance Sheet.

The option that matters is General/Budget, the budget to use (the book's default budget if you leave it out); the other options are those of the Balance Sheet.

Examples

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

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": " Budget Balance Sheet test budget",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Assets",
                    "…": "…"
                  },
                  {
                    "display": "$3,223.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

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

{
  "title": " Budget Balance Sheet test budget",
  "sections": [
    {
      "blocks": [
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            {
              "role": "total",
              "cells": [
                {
                  "text": "Total Assets",
                  "…": "…"
                },
                {
                  "display": "$3,223.00",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

{"name":"report.run","arguments":{"report":"Budget Balance Sheet"}}

{
  "structuredContent": {
    "title": " Budget Balance Sheet test budget",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Assets",
                    "…": "…"
                  },
                  {
                    "display": "$3,223.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: ecc35ea9dbfa4e20ba389fc85d59cb69 · Script: standard/budget-balance-sheet.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 assets section (boolean, default true): Whether or not to include a label for the assets section.
• Include assets total (boolean, default true): Whether or not to include a line indicating total assets.
• Label the liabilities section (boolean, default true): Whether or not to include a label for the liabilities section.
• Include liabilities total (boolean, default true): Whether or not to include a line indicating total liabilities.
• Label the equity section (boolean, default true): Whether or not to include a label for the equity section.
• Include equity total (boolean, default true): Whether or not to include a line indicating total equity.
• Include new/existing totals (boolean, default true): Whether or not to include lines indicating change in totals introduced by budget.

General

• Report name (string, default "Budget Balance Sheet"): 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 Balance Sheet"): Title for this report.
• Single column Balance Sheet (boolean, default true): Print liability/equity section in the same column under the assets section as opposed to a second column right of the assets section.
• Budget (budget, default null): Budget to use.