Actions89
- General Actions
- About API Actions
- Accounts API Actions
- Available Budgets API Actions
- Bills API Actions
- Budgets API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
- Piggy Banks API Actions
- Object Groups API Actions
- Recurrences API Actions
Available Budgets API → List Available Budgets
AI-generatedOverview
This node operation lists available budgets from the FireFly III API. It retrieves read-only, automatically calculated budget amounts that are available within a specified date range and supports pagination. This is useful for users who want to view their budget availability over time without modifying the budgets themselves.
Use Case Examples
- A user wants to see all available budgets for the year 2025, limiting the results to 50 per page.
- A user needs to fetch available budgets between January 1, 2025, and December 31, 2025, and navigate through pages of results.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Date Range Filters | Filters to specify the start and end dates (YYYY-MM-DD) for the available budgets to be listed. |
| Pagination Options | Options to control the pagination of the results, including the maximum number of results per page and the page number to retrieve. |
Output
JSON
json- The JSON response containing the list of available budgets retrieved from the FireFly III API.
Dependencies
- FireFly III API with OAuth2 authentication
Troubleshooting
- Ensure the OAuth2 credentials are correctly configured to authenticate API requests.
- Verify that the date range filters are in the correct YYYY-MM-DD format to avoid API errors.
- If pagination parameters are set incorrectly (e.g., limit less than 1), the API may return errors or unexpected results.
Links
- FireFly III API Documentation - Available Budgets - Official API documentation for listing available budgets in FireFly III.