Account Summary

The Account Summary report.

Lists the balance of each selected account on one date, with sub-accounts rolled up to the depth you choose. Use it for a quick look at where every account stands. Unlike the Balance Sheet it has no sections, totals or equity lines, and it shows income and expense accounts too. In GnuCash: Reports ▸ Account Summary.

The options that matter are Accounts/Accounts and Accounts/Levels of Subaccounts (what to show and how deep), General/Date (the date the balances are taken at) and Commodities/Price Source (how foreign balances are converted to the report currency). A balance in another currency has no figure of its own in a cell and lists the amount in that currency with its converted value.

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":"Account Summary","options":{"General":{"Date":{"absolute":"1978-12-31"}}}}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": " Account Summary 12/31/78",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              {
                "role": "account",
                "cells": [
                  {
                    "text": "",
                    "…": "…"
                  },
                  {
                    "text": "Bank",
                    "…": "…"
                  },
                  {
                    "display": "$2,181.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

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

It prints:

{
  "title": " Account Summary 12/31/78",
  "sections": [
    {
      "blocks": [
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            {
              "role": "account",
              "cells": [
                {
                  "text": "",
                  "…": "…"
                },
                {
                  "text": "Bank",
                  "…": "…"
                },
                {
                  "display": "$2,181.00",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

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

Result:

{
  "structuredContent": {
    "title": " Account Summary 12/31/78",
    "sections": [
      {
        "blocks": [
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              {
                "role": "account",
                "cells": [
                  {
                    "text": "",
                    "…": "…"
                  },
                  {
                    "text": "Bank",
                    "…": "…"
                  },
                  {
                    "display": "$2,181.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: 3298541c236b494998b236dfad6ad752 · Script: standard/account-summary.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.
Depth limit behavior (multichoice, default "summarize"): How to treat accounts which exceed the specified depth limit (if any). * Show the total balance, including balances in subaccounts, of any account at the depth limit. * Raise accounts deeper than the depth limit to the depth limit. * Omit any accounts deeper than 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.
Account Balance (boolean, default true): Show an account's balance.
Account Code (boolean, default true): Show an account's account code.
Account Description (boolean, default false): Show an account's description.
Account Type (boolean, default false): Show an account's account type.
Account Notes (boolean, default false): Show an account's notes.

General

Report name (string, default "Account Summary"): 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 "Account Summary"): Title for this report.
Date (date, default {"relative":"end-accounting-period"}): Select a date to report on.