manage-scheduled-transaction
Create, update, or delete recurring transactions like bills or savings transfers to manage automated financial workflows efficiently.
Instructions
Create, update, or delete a single scheduled (recurring) transaction. Use this to manage recurring bills or savings transfers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | The action to perform. | |
| budget_id | No | The ID of the budget. If not provided, the default budget will be used. | |
| transaction_data | No | The data for the scheduled transaction to create or update. | |
| transaction_id | No | The ID of the scheduled transaction to update or delete. |
Input Schema (JSON Schema)
{
"$defs": {
"ManageScheduledTransactionAction": {
"enum": [
"create",
"update",
"delete"
],
"title": "ManageScheduledTransactionAction",
"type": "string"
},
"ScheduledTransaction": {
"properties": {
"account_id": {
"description": "The ID of the account for the transaction.",
"title": "Account Id",
"type": "string"
},
"amount": {
"description": "The transaction amount in milliunits.",
"title": "Amount",
"type": "number"
},
"category_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the category for the transaction.",
"title": "Category Id"
},
"date": {
"description": "The transaction date in YYYY-MM-DD format.",
"title": "Date",
"type": "string"
},
"flag_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The flag color of the transaction.",
"title": "Flag Color"
},
"frequency": {
"description": "The frequency of the scheduled transaction (e.g. 'daily', 'weekly', 'monthly').",
"title": "Frequency",
"type": "string"
},
"import_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A unique import ID for the transaction. Use for idempotency.",
"title": "Import Id"
},
"memo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A memo for the transaction.",
"title": "Memo"
},
"payee_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the payee.",
"title": "Payee Id"
},
"payee_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the payee. If not provided, a new payee will be created.",
"title": "Payee Name"
}
},
"required": [
"account_id",
"date",
"amount",
"frequency"
],
"title": "ScheduledTransaction",
"type": "object"
}
},
"properties": {
"action": {
"$ref": "#/$defs/ManageScheduledTransactionAction",
"description": "The action to perform."
},
"budget_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the budget. If not provided, the default budget will be used.",
"title": "Budget Id"
},
"transaction_data": {
"anyOf": [
{
"$ref": "#/$defs/ScheduledTransaction"
},
{
"type": "null"
}
],
"default": null,
"description": "The data for the scheduled transaction to create or update."
},
"transaction_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the scheduled transaction to update or delete.",
"title": "Transaction Id"
}
},
"required": [
"action"
],
"title": "ManageScheduledTransactionInput",
"type": "object"
}