FireFly III icon

FireFly III

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

Actions89

General → Export Data

AI-generated

Overview

This node operation allows exporting various types of financial data from the FireFly III API. It supports exporting data such as accounts, bills, budgets, categories, piggy banks, recurring transactions, rules, tags, and transactions. Users can specify the export type, format (e.g., CSV), and for transactions, a date range and account IDs can be provided. The exported data can be used for reporting, backup, or integration with other systems.

Use Case Examples

  1. Export all accounts data in CSV format for reporting.
  2. Export transactions within a specific date range for financial analysis.
  3. Export budgets and categories data for backup or migration.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Export Type The type of data to export, such as accounts, bills, budgets, categories, piggy banks, recurring transactions, rules, tags, or transactions.
Format The format to export the data in, such as CSV or none (default).
Start Date Start date for the export in YYYY-MM-DD format, required for transactions export.
End Date End date for the export in YYYY-MM-DD format, required for transactions export.
Account IDs Comma-separated list of account IDs to filter transactions export.

Output

Binary

Contains the exported data file, typically in CSV format, with the filename derived from the response headers or defaulted to 'export.csv'.

JSON

  • json - Empty JSON object as the main data is provided in binary format.
  • binary
    • data - The binary data of the exported file, ready for download or further processing.

Dependencies

  • Requires FireFly III API access with OAuth2 authentication.

Troubleshooting

  • Ensure the date range (start and end) is provided when exporting transactions, as it is required.
  • Verify that the account IDs are correctly formatted as a comma-separated string when filtering transactions.
  • Check API permissions and OAuth2 credentials if the export request fails due to authorization errors.
  • If the exported file is not received, verify the response headers for 'content-disposition' to correctly extract the filename.

Links

Discussion