Method

scheduledTransaction.get

One scheduled transaction with its template transactions.

Returns one scheduled transaction with its Schedule, end, last occurrence, next occurrence, deferred instances and template transactions. variables lists every variable its formulas name, with i. Template transactions live apart from the account tree, so no balance or report sees them.

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.get","params":{"scheduledTransaction":"52f96837087e9670c933f9421b0ac626"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "guid": "52f96837087e9670c933f9421b0ac626",
    "name": "Monthly rent",
    "enabled": true,
    "end": {
      "date": "2025-07-01"
    },
    "lastOccurrence": "2024-09-01",
    "nextOccurrence": "2024-10-01",
    "schedule": [
      {
        "mult": 1,
        "periodType": "month",
        "…": "…"
      }
    ],
    "templateTransactions": [
      {
        "description": "Rent",
        "splits": [
          {
            "debitFormula": "456",
            "creditFormula": "",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      }
    ],
    "variables": [
      "i"
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash scheduledTransaction.get '{"scheduledTransaction":"52f96837087e9670c933f9421b0ac626"}'

It prints:

{
  "guid": "52f96837087e9670c933f9421b0ac626",
  "name": "Monthly rent",
  "enabled": true,
  "end": {
    "date": "2025-07-01"
  },
  "lastOccurrence": "2024-09-01",
  "nextOccurrence": "2024-10-01",
  "schedule": [
    {
      "mult": 1,
      "periodType": "month",
      "…": "…"
    }
  ],
  "templateTransactions": [
    {
      "description": "Rent",
      "splits": [
        {
          "debitFormula": "456",
          "creditFormula": "",
          "…": "…"
        },
        "…"
      ],
      "…": "…"
    }
  ],
  "variables": [
    "i"
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"scheduledTransaction.get","arguments":{"scheduledTransaction":"52f96837087e9670c933f9421b0ac626"}}

Result:

{
  "structuredContent": {
    "guid": "52f96837087e9670c933f9421b0ac626",
    "name": "Monthly rent",
    "enabled": true,
    "end": {
      "date": "2025-07-01"
    },
    "lastOccurrence": "2024-09-01",
    "nextOccurrence": "2024-10-01",
    "schedule": [
      {
        "mult": 1,
        "periodType": "month",
        "…": "…"
      }
    ],
    "templateTransactions": [
      {
        "description": "Rent",
        "splits": [
          {
            "debitFormula": "456",
            "creditFormula": "",
            "…": "…"
          },
          "…"
        ],
        "…": "…"
      }
    ],
    "variables": [
      "i"
    ],
    "…": "…"
  }
}

Effect: read.

Params

Names one scheduled transaction.

  • scheduledTransaction (Guid, required): The scheduled transaction.

Result

A scheduled transaction, with every field GnuCash's file holds.

  • guid (Guid, required): Identity.
  • name (string, required): The name; names need not be unique.
  • enabled (boolean, required): Disabled ones are left out of Since Last Run and the forecasts.
  • startDate (Date, required): The first possible occurrence.
  • end (End, required): The end, as stored.
  • lastOccurrence (Date or null): The last occurrence acted on (created, ignored or postponed), or null if never run.
  • instanceCount (integer (int32), required): The Instance count: the value of i for the next instance.
  • autoCreate (boolean, required): Create due instances without asking.
  • notify (boolean, required): And say so.
  • advanceCreateDays (integer (int32), required): Days ahead to create.
  • advanceRemindDays (integer (int32), required): Days ahead to remind, after that.
  • schedule (array of Recurrence, required): The Schedule, as stored.
  • nextOccurrence (Date or null): The next occurrence after the last (or the first), or null when it has ended or never occurs.
  • deferredInstances (array of DeferredInstance, required): The state saved before each postponed instance, in file order.
  • templateAccount (Guid or null): The template account's GUID, or null when there is none.
  • templateTransactions (array of TemplateTransaction or null): The template transactions, in the template account's split order; absent in scheduledTransaction.list.
  • variables (array of string, required): Every variable the formulas name, i and the exchange-rate variables, sorted bytewise.
  • warnings (array of WarningInfo or null): What GnuCash's editor would have asked to confirm; only from methods that write.