Report

Balance Sheet (Multicolumn)

The Balance Sheet (Multicolumn) report.

A balance sheet with one column for each period between two dates, so you can compare the same accounts over time. The result is a group of blocks, one for each period or section. Use it for monthly or yearly comparisons; for a single date use the Balance Sheet. In GnuCash: Reports ▸ Assets & Liabilities ▸ Balance Sheet (Multicolumn).

The options that matter are General/Start Date and End Date, General/Period duration (the length of a column), General/Period order is most recent first, General/Enable dual columns and the Commodities options. Foreign accounts are converted at the rate for the date of each column, and Commodities/Show Exchange Rates lists the rates used.

Examples

Example: with a copy of the reports/balsheet-pnl-extras 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 (Multicolumn)","options":{"General":{"Start Date":{"absolute":"2023-01-01"},"End Date":{"absolute":"2024-01-01"}}}}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "Balance Sheet (Multicolumn) 01/01/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "group",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash report.run '{"report":"Balance Sheet (Multicolumn)","options":{"General":{"Start Date":{"absolute":"2023-01-01"},"End Date":{"absolute":"2024-01-01"}}}}'

It prints:

{
  "title": "Balance Sheet (Multicolumn) 01/01/24",
  "sections": [
    {
      "blocks": [
        {
          "kind": "group",
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Balance Sheet (Multicolumn)","options":{"General":{"Start Date":{"absolute":"2023-01-01"},"End Date":{"absolute":"2024-01-01"}}}}}

Result:

{
  "structuredContent": {
    "title": "Balance Sheet (Multicolumn) 01/01/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "group",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: 065d5d5a77ba11e8b31e83ada73c5eea · Script: standard/balsheet-pnl.rhai

Options

Accounts

  • Accounts (accountList, default []): Report on these accounts, if display depth allows.
  • Levels of Subaccounts (multichoice, default "all"): Maximum number of levels in the account tree displayed.

Commodities

  • Common Currency (boolean, default false): Convert all amounts to a single currency.
  • 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 original currency amount (boolean, default true): Also show original currency amounts
  • Show Exchange Rates (boolean, default true): 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 amounts include children (boolean, default true): If this option is enabled, subtotals are displayed within parent amounts, and if parent has own amount, it is displayed on the next row as a child account. If this option is disabled, subtotals are displayed below parent and children groups.
  • Display accounts as hyperlinks (boolean, default true): Shows each account in the table as a hyperlink to its register window.
  • Display amounts as hyperlinks (boolean, default true): Shows each amounts in the table as a hyperlink to a register or report.
  • Account full name instead of indenting (boolean, default false): Selecting this option enables full account name instead, and disables indenting account names.
  • Label sections (boolean, default true): Whether or not to include a label for sections.
  • Include totals (boolean, default true): Whether or not to include a line indicating total amounts.

General

  • Report name (string, default "Balance Sheet (Multicolumn)"): 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.
  • Period duration (multichoice, default "disabled"): Duration between time periods
  • Disable amount indenting (boolean, default false): Selecting this option will disable amount indenting, and condense amounts into a single column.
  • Enable dual columns (boolean, default true): Selecting this option will enable double-column reporting.
  • Enable chart (boolean, default false): Enable link to chart
  • Period order is most recent first (boolean, default true): Period order is most recent first
  • Start Date (date, default {"relative":"start-accounting-period"}): Start of reporting period.
  • End Date (date, default {"relative":"end-accounting-period"}): End of reporting period.