Report

Income Statement (Multicolumn)

The Income Statement (Multicolumn) report.

An income statement with one column for each period between two dates, for comparing revenues and expenses over time. The result is a group of blocks. For a single period use the Income Statement. In GnuCash: Reports ▸ Income & Expense ▸ Income Statement (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 and the Commodities options.

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":"Income Statement (Multicolumn)","options":{"General":{"Start Date":{"absolute":"2023-01-01"},"End Date":{"absolute":"2024-03-31"}}}}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "Income Statement (Multicolumn) 01/01/23 to 03/31/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "group",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

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

It prints:

{
  "title": "Income Statement (Multicolumn) 01/01/23 to 03/31/24",
  "sections": [
    {
      "blocks": [
        {
          "kind": "group",
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Income Statement (Multicolumn)","options":{"General":{"Start Date":{"absolute":"2023-01-01"},"End Date":{"absolute":"2024-03-31"}}}}}

Result:

{
  "structuredContent": {
    "title": "Income Statement (Multicolumn) 01/01/23 to 03/31/24",
    "sections": [
      {
        "blocks": [
          {
            "kind": "group",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: 0e94fd0277ba11e8825d43e27232c9d4 · 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 "Income Statement (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
  • If more than 1 period column, include overall period? (boolean, default false): If several profit & loss period columns are shown, also show overall period profit & loss.
  • Start Date (date, default {"relative":"start-accounting-period"}): Start of reporting period.
  • End Date (date, default {"relative":"end-accounting-period"}): End of reporting period.