scheduledTransaction.list

Scheduled transactions in book order.

Lists scheduled transactions in book order, without their template transactions. Filter to the enabled or the disabled ones, or to those whose template splits use a given account (to see what depends on an account before changing it).

Examples

Example: with a copy of the synthetic/rich example book open as book.gnucash.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"scheduledTransaction.list","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "scheduledTransactions": [
      {
        "guid": "52f96837087e9670c933f9421b0ac626",
        "name": "Monthly rent",
        "enabled": true,
        "…": "…"
      }
    ]
  }
}

Request:

{"jsonrpc":"2.0","id":2,"method":"scheduledTransaction.list","params":{"enabled":false}}

Response:

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "scheduledTransactions": []
  }
}

Command line

red-ale exec --book book.gnucash --script - <<'EOF'
scheduledTransaction.list {}
scheduledTransaction.list {"enabled":false}
EOF

It prints:

[
  {
    "scheduledTransactions": [
      {
        "guid": "52f96837087e9670c933f9421b0ac626",
        "name": "Monthly rent",
        "enabled": true,
        "…": "…"
      }
    ]
  },
  {
    "scheduledTransactions": []
  }
]

MCP tool call

Tool call:

{"name":"scheduledTransaction.list","arguments":{}}

Result:

{
  "structuredContent": {
    "scheduledTransactions": [
      {
        "guid": "52f96837087e9670c933f9421b0ac626",
        "name": "Monthly rent",
        "enabled": true,
        "…": "…"
      }
    ]
  }
}

Tool call:

{"name":"scheduledTransaction.list","arguments":{"enabled":false}}

Result:

{
  "structuredContent": {
    "scheduledTransactions": []
  }
}

Effect: read.

Params

Params of scheduledTransaction.list.

enabled (boolean or null): Only those enabled, or only those disabled.
account (AccountRef or null): Only those whose template splits name this account.

Result

The result of scheduledTransaction.list.

scheduledTransactions (array of ScheduledTransactionInfo, required): In book order, without their template transactions.