Report

Multicolumn View

The Multicolumn View report.

A page that holds other reports side by side, in a grid. Each child is a report template or a saved configuration, with its own options and the number of columns and rows it spans. Use it to put a balance sheet and an income statement on one page; report.export renders them together through one style sheet. In GnuCash: Reports ▸ Multicolumn ▸ Custom Multicolumn Report.

The children are the option __general/report-list, an array of {report, options, colspan, rowspan} where report is the GUID of a template or saved configuration (not a name) and options only goes with a template's GUID. A child that fails, or that no longer exists, shows a warning in its cell instead of stopping the page. Views can nest to four levels and a run can have 100 children.

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":"Multicolumn View","options":{"__general":{"report-list":[{"report":"c4173ac99b2b448289bf4d11c731af13"},{"report":"0b81a3bdfd504aff849ec2e8630524bc"}]}}}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "",
    "sections": [
      {
        "blocks": [
          {
            "kind": "grid",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash report.run '{"report":"Multicolumn View","options":{"__general":{"report-list":[{"report":"c4173ac99b2b448289bf4d11c731af13"},{"report":"0b81a3bdfd504aff849ec2e8630524bc"}]}}}'

It prints:

{
  "title": "",
  "sections": [
    {
      "blocks": [
        {
          "kind": "grid",
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Multicolumn View","options":{"__general":{"report-list":[{"report":"c4173ac99b2b448289bf4d11c731af13"},{"report":"0b81a3bdfd504aff849ec2e8630524bc"}]}}}}

Result:

{
  "structuredContent": {
    "title": "",
    "sections": [
      {
        "blocks": [
          {
            "kind": "grid",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: d8ba4a2e89e8479ca9f6eccdeb164588 · Script: standard/view-column.rhai

Options

General

  • Report name (string, default "Multicolumn View"): 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.
  • Number of columns (numberRange, default 1): Number of columns before wrapping to a new row.

__general

  • report-list (reportPlacement, default []): The reports to show, in order: each a report template or saved report configuration by GUID, with the columns and rows it spans.