FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

Budgets API → Create Budget

AI-generated

Overview

This node operation allows users to create a new budget in the FireFly III financial management system using the Budgets API. It is useful for automating budget creation workflows, such as setting up monthly budgets for different expense categories or projects. Users can specify the budget name and various optional fields like activation status, automatic budget allocation details, and notes.

Use Case Examples

  1. Create a monthly grocery budget with automatic allocation of 500 EUR.
  2. Set up an active budget with notes for tracking a specific project.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Name The name of the budget to be created.
Additional Budget Fields Optional fields to specify additional budget details such as activation status, automatic budget amount, currency code or ID, budget period, budget type, and notes.

Output

JSON

  • json - The JSON response from the FireFly III API containing the details of the created budget.

Dependencies

  • Requires an API key credential for FireFly III OAuth2 authentication to access the FireFly III API.

Troubleshooting

  • Ensure the 'Name' field is provided as it is required; missing it will cause an error.
  • Verify that either 'auto_budget_currency_code' or 'auto_budget_currency_id' is used, but not both simultaneously.
  • Check the UUID format for 'X-Trace-ID' if used for tracing; invalid format may cause request failures.
  • API authentication errors may occur if the OAuth2 credentials are not correctly configured.

Links

Discussion