Actual Budget icon

Actual Budget

Read budgets, list accounts and balances, list/create categories, and create transactions in Actual Budget via actual-http-api `/v1` routes (official endpoints)

Actual Budget

AI-generated

Summary

Execute various actions in Actual Budget such as creating transactions, managing categories, retrieving budget months, listing accounts, and getting account balances using the actual-http-api '/v1' endpoints.

Inputs

  • Action (required) — The specific action to perform: create a transaction, create or list categories, get budget month, list accounts, or get account balance.
  • Account (required) — Account ID for transaction creation or balance retrieval (required for 'transactionCreate' and 'accountGetBalance' actions).
  • Category Source (required) — Choose whether to use an existing category or create a new one before posting a transaction (only for 'transactionCreate').
  • Category (required) — Category ID when using an existing category for a transaction (for 'transactionCreate' with existing category).
  • New Category Name (required) — Name of the new category to create before attaching to the transaction (for 'transactionCreate' with new category).
  • New Category Group (required) — Parent category group for the new category (for 'transactionCreate' with new category and for direct category creation).
  • New Category Is Income — Indicates if the new category is an income category (default false).
  • New Category Hidden — Indicates if the new category is hidden initially (default false).
  • Amount (required) — Transaction amount in integer minor units (e.g., -7374 for -73.74) for 'transactionCreate'.
  • Date (required) — Transaction date in YYYY-MM-DD format for 'transactionCreate'. Time portion is ignored.
  • Payee Name (required) — Payee label for the transaction in 'transactionCreate'.
  • Notes — Optional memo for the transaction; sent only when non-empty (for 'transactionCreate').
  • Cleared — Whether the transaction is cleared (for 'transactionCreate').
  • Learn Categories — Whether to pass learnCategories to actual-http-api during transaction creation.
  • Run Transfers — Whether to pass runTransfers to actual-http-api during transaction creation.
  • Category Name (required) — Display name for direct category creation ('categoryCreate' action).
  • Is Income — Indicates if a directly created category is income (default false).
  • Hidden — Indicates if a directly created category is hidden (default false).
  • Month (required) — Budget month in YYYY-MM format for retrieving budget month data ('budgetGet' action).
  • Balance Cutoff Date — Optional cutoff date (YYYY-MM-DD) to get account balance as of this day (for 'accountGetBalance').

Output shape

a list of JSON objects representing API response data, with structure depending on the action performed

For 'transactionCreate' action with new category, output includes created category details and related requests. For 'categoryCreate', output includes the created category ID. Outputs correspond directly to actual-http-api JSON responses, with added request echo. Errors are returned per item when 'Continue on Fail' is enabled.

Examples

Example 1: Create a transaction with an existing category

Set Action to 'Transaction: Create', select an existing Account and Category, provide amount, date, payee name, and optional notes. Set cleared, learnCategories, and runTransfers as needed.

Example 2: Create a new category then post a transaction

Set Action to 'Transaction: Create', select Account, set Category Source to 'Create New', specify new category name, group, income flag and hidden flag. Provide transaction details as above.

Example 3: Retrieve a budget month

Set Action to 'Budget: Get Month', specify month in YYYY-MM format.

Links

Discussion