Report

Balance Sheet

The Balance Sheet report.

Assets, liabilities and equity on one date, with a total for each. Use it to see what you own, what you owe and what is left. Income and expenses to date appear as Retained Earnings in equity, with Unrealized Gains or Unrealized Losses for the effect of prices, so that assets always equal liabilities plus equity. In GnuCash: Reports ▸ Assets & Liabilities ▸ Balance Sheet.

The options that matter are General/Balance Sheet Date, Accounts/Accounts and Levels of Subaccounts, Commodities/Report's currency and Price Source, and the Display options that choose which sections and totals show. General/Single column Balance Sheet and General/Use standard US layout choose the layout.

Examples

Example: with a copy of the reports/test-data 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":"Balance Sheet","options":{"General":{"Balance Sheet Date":{"absolute":"1978-12-31"}}}}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": " Balance Sheet 12/31/78",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Assets",
                    "…": "…"
                  },
                  {
                    "display": "$3,057.80",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash report.run '{"report":"Balance Sheet","options":{"General":{"Balance Sheet Date":{"absolute":"1978-12-31"}}}}'

It prints:

{
  "title": " Balance Sheet 12/31/78",
  "sections": [
    {
      "blocks": [
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            {
              "role": "total",
              "cells": [
                {
                  "text": "Total Assets",
                  "…": "…"
                },
                {
                  "display": "$3,057.80",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Balance Sheet","options":{"General":{"Balance Sheet Date":{"absolute":"1978-12-31"}}}}}

Result:

{
  "structuredContent": {
    "title": " Balance Sheet 12/31/78",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "total",
                "cells": [
                  {
                    "text": "Total Assets",
                    "…": "…"
                  },
                  {
                    "display": "$3,057.80",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: c4173ac99b2b448289bf4d11c731af13 · Script: standard/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.

General

  • Report name (string, default "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 "Balance Sheet"): Title for this report.
  • Balance Sheet Date (date, default {"relative":"end-accounting-period"}): Select a date to report on.
  • 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.
  • Use standard US layout (boolean, default true): Report section order is assets/liabilities/equity (rather than assets/equity/liabilities).