Cash Flow

The Cash Flow report.

The money that came into and went out of the selected accounts (usually the bank, cash and credit card accounts) between two dates, listed by the other account it came from or went to, with the difference between the two. Use it to see where your money moved. Transfers between two selected accounts are left out. In GnuCash: Reports ▸ Income & Expense ▸ Cash Flow.

The options that matter are Accounts/Account (the accounts that count as cash), General/Start Date and End Date, and General/Show Full Account Names. The result starts with the list of the selected accounts (General/Show Selected Accounts), then the table.

Examples

Example: with a copy of the reports/cash-flow 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":"Cash Flow"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "title": "Cash Flow - 01/01/24 to 12/31/24",
    "sections": [
      {
        "blocks": [
          "…",
          "…",
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "grandTotal",
                "cells": [
                  {
                    "text": "Difference",
                    "…": "…"
                  },
                  {
                    "display": "$150.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash report.run '{"report":"Cash Flow"}'

It prints:

{
  "title": "Cash Flow - 01/01/24 to 12/31/24",
  "sections": [
    {
      "blocks": [
        "…",
        "…",
        {
          "kind": "table",
          "rows": [
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            "…",
            {
              "role": "grandTotal",
              "cells": [
                {
                  "text": "Difference",
                  "…": "…"
                },
                {
                  "display": "$150.00",
                  "…": "…"
                }
              ],
              "…": "…"
            },
            "…"
          ],
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    },
    "…"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"report.run","arguments":{"report":"Cash Flow"}}

Result:

{
  "structuredContent": {
    "title": "Cash Flow - 01/01/24 to 12/31/24",
    "sections": [
      {
        "blocks": [
          "…",
          "…",
          {
            "kind": "table",
            "rows": [
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              "…",
              {
                "role": "grandTotal",
                "cells": [
                  {
                    "text": "Difference",
                    "…": "…"
                  },
                  {
                    "display": "$150.00",
                    "…": "…"
                  }
                ],
                "…": "…"
              },
              "…"
            ],
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      },
      "…"
    ],
    "…": "…"
  }
}

Template GUID: f8748b813fab4220ba26e743aedf38da · Script: standard/cash-flow.rhai

Options

Accounts

Account Display Depth (multichoice, default 2): Show accounts to this depth, overriding any other option.
Always show sub-accounts (boolean, default false): Override account-selection and show sub-accounts of all selected accounts?
Account (accountList, default []): Report on these accounts, if display depth allows.
Include Trading Accounts in report (boolean, default false): Include transfers to and from Trading Accounts in the report. As in GnuCash 5.17 this works backwards: off counts transfers to and from Trading Accounts, on leaves them out.

General

Report name (string, default "Cash Flow"): 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.
Start Date (date, default {"relative":"start-accounting-period"}): Start of reporting period.
End Date (date, default {"relative":"end-accounting-period"}): End of reporting period.
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 Exchange Rates (boolean, default false): Show the exchange rates used.
Show Full Account Names (boolean, default true): Show full account names (including parent accounts).
Show Selected Accounts (boolean, default true): Show the list of selected accounts on the top of this report.