FireFly III icon

FireFly III

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

Actions89

Accounts API → Create Account

AI-generated

Overview

This node operation creates a new account in the FireFly III system using the Accounts API. It is useful for automating the addition of financial accounts such as assets, expenses, liabilities, and more. For example, a user can create a new asset account with specific details like name, type, currency, and opening balance.

Use Case Examples

  1. Creating a new asset account named 'Savings Account' with an opening balance and currency specified.
  2. Automating the creation of multiple accounts for different financial categories in a budgeting workflow.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Name The name of the new account to be created.
Account Type The type of the account, such as asset, expense, import, revenue, cash, liability, etc.
Account Fields Additional optional fields to set for the account, such as IBAN, BIC, account number, opening balance, currency, active status, account role, credit card type, liability type, interest, notes, location coordinates, and zoom level.

Output

JSON

  • id - The unique identifier of the created account.
  • name - The name of the created account.
  • type - The type of the created account.
  • iban - The IBAN of the account if provided.
  • bic - The BIC of the account if provided.
  • account_number - The account number if provided.
  • opening_balance - The opening balance of the account if provided.
  • opening_balance_date - The date of the opening balance if provided.
  • virtual_balance - The virtual balance amount if provided.
  • currency_id - The currency ID used for the account if provided.
  • currency_code - The currency code used for the account if provided.
  • active - Indicates whether the account is active.
  • order - The order of the account.
  • include_net_worth - Whether to include this account in net worth calculations.
  • account_role - The role of the account, mandatory when the type is asset.
  • credit_card_type - The type of credit card if applicable.
  • monthly_payment_date - The monthly payment date for credit card accounts.
  • liability_type - The type of liability if the account is a liability.
  • interest - The interest percentage if the account is a liability.
  • interest_period - The period for interest calculation if the account is a liability.
  • notes - Notes associated with the account.
  • latitude - Latitude of the account's location.
  • longitude - Longitude of the account's location.
  • zoom_level - Zoom level for the map location of the account.

Dependencies

  • An API key credential for FireFly III API authentication.

Troubleshooting

  • Ensure that the 'Name' and 'Account Type' fields are provided as they are required for account creation.
  • Verify that the API credentials are correctly configured and have the necessary permissions to create accounts.
  • If the API returns an error, check the provided account fields for correct data types and valid values, especially for fields like dates and currency codes.
  • Use the X-Trace-ID for debugging and tracing requests if issues arise.

Links

Discussion