ActualBudget icon

ActualBudget

Consume ActualBudget API

Get Budget Month

AI-generated

Overview

This node interacts with the ActualBudget API to retrieve budget data for a specific month. It is useful for scenarios where users want to fetch detailed budget information for a given month, such as generating monthly financial reports or analyzing budget performance. For example, a user can specify a budget ID and a month (in YYYY-MM format) to get the budget details for that month.

Use Case Examples

  1. Fetch budget data for March 2024 by providing the budget ID and month '2024-03'.
  2. Use the node to retrieve budget information for a specific month to integrate with other financial tools or dashboards.

Properties

Name Meaning
Budget ID The ID of the Budget you are working on/with, required to identify the budget.
Month Month in YYYY-MM format, required to specify the month for which budget data is retrieved.

Output

JSON

  • month - The month for which the budget data is retrieved.
  • incomeAvailable - Total income available for the specified month.
  • lastMonthOverspent - Amount overspent in the last month.
  • forNextMonth - Amount buffered for the next month.
  • totalBudgeted - Total budgeted amount for the month.
  • toBudget - Amount allocated to budget.
  • fromLastMonth - Amount carried over from the last month.
  • totalIncome - Total income for the month.
  • totalSpent - Total amount spent in the month.
  • totalBalance - Total balance leftover in the month.
  • categoryGroups - Array of category groups with budget details and categories for the month.

Dependencies

  • an API key credential for ActualBudget API

Troubleshooting

  • Ensure the 'Budget ID' and 'Month' parameters are correctly provided and formatted as required.
  • Check API credentials and network connectivity to the ActualBudget API service.
  • If the API returns errors, verify the budget ID exists and the month is within the valid range.

Links

Discussion