scheduledTransaction.delete

Delete a scheduled transaction with its template account and template transactions.

Deletes a scheduled transaction with its template account and template transactions. The transactions it already created stay in the book. To keep it but stop it running, set enabled: false with scheduledTransaction.update.

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

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "deleted": true
  }
}

Request:

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

Response:

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

Command line

red-ale exec --book book.gnucash --script - <<'EOF'
scheduledTransaction.delete {"scheduledTransaction":"52f96837087e9670c933f9421b0ac626"}
scheduledTransaction.list {}
EOF

It prints:

[
  {
    "deleted": true
  },
  {
    "scheduledTransactions": []
  }
]

MCP tool call

Tool call:

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

Result:

{
  "structuredContent": {
    "deleted": true
  }
}

Tool call:

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

Result:

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

Effect: destructive, on the Book.

Params

Names one scheduled transaction.

scheduledTransaction (Guid, required): The scheduled transaction.

Result

The result of scheduledTransaction.delete.

deleted (boolean, required): Always true.