Skip to content

vfadlan/fireporter

Repository files navigation

Fireporter: Firefly III PDF Exporter

fireporter-38.png

Fireporter is a third-party app for Firefly III, it uses Firefly's API to download your financial records and process it to a PDF file.

🚀 Installation

Download the latest Fireporter version here: Fireporter Latest Version

MacOs x64 (Intel) (Build from Source)

Fireporter does not offer pre-built binaries for MacOS old architecture. You must build the application from the source code. Guide on building Fireporter binaries

📋 Requirements

  • Firefly III version 6.x.x
  • Personal Access Token (PAT)

🛠️ Usage

  1. Enter the address to access your Firefly III installation.
  2. Enter a Personal Access Token from your Firefly III account. You can create one on Options -> Profile -> OAuth page.
  3. Choose the period you want to report.
  4. Click Generate to create the PDF.

⚠️ Important Notes

  • Currently, supports any currency but not multiple currencies. E.g. you can only have one currency in your Firefly III adminstration.
  • Release are available for Windows x64, Linux x64, and MacOS (Apple Silicon). But only Windows version that has been tested.
  • Fireporter only reads data from Firefly III via API and formats it into a PDF.
  • Tips: Store attachments as image instead of pdf for faster process. Fireporter will have to convert entire pages of PDF file to multiple image files before attaching it to generated report.

📄 Disclaimer

Fireporter is provided "as is", without warranty of any kind. The developer is not responsible for any loss, damage, or errors caused by use of this application. Use at your own risk.

📜 License

This project is licensed under the GNU AGPL v3.0.

📌 Changelog

2.0.10 - 2025/12/13

  • (FIX) - Fix icon on linux installers (.deb and .rpm)

2.0.9 - 2025/12/11

  • (FIX) - Correct year to 4 quarter periods instead of 3 on Q4

2.0.8 - 2025/12/10

  • (FIX) Corrected quarter date range test case from 4 months to 3 months
  • (FIX) Made foreignCurrencyDecimalPlaces nullable
  • (FIX) Throw InactiveAccountException for date ranges with zero transactions

2.0.7 - 2025/12/08

  • (BUILD) Write build tasks and Github action jobs to build for .rpm distribution file

2.0.6 - 2025/11/11

  • (FIX) - Correct year to 4 quarter periods instead of 3

2.0.5 - 2025/11/01

  • (FIX) - Faulty initial and ending balance approximation of asset accounts

2.0.4 - 2025/09/03

  • (REFACTOR) Improve transaction report table layout
  • (REFACTOR) Improve column header choice of words
  • (FEATURE) Add bookmarks to headings

2.0.3 - 2025/08/26

  • (FEATURE) Added theme-based background colors to column headers in Transaction History

2.0.2 - 2025/08/24

  • (BUG FIX) Fixed missing application icon on Linux
  • (BUG FIX) Fixed incorrect application and installer name on Linux
  • (BUG FIX) Fixed truncation of application name and version in the UI
  • (BUG FIX) Fixed issue where inactive accounts were ignored instead of throwing InactiveAccountException
  • (BUG FIX) Fixed incorrect initial balance calculation
  • (BUG FIX) Fixed unresolved decimalPlaces when fetching currencies
  • (REFACTOR) Added and implement safeRequest utility for centralized HTTP error handling (throws ClientErrorException on 4xx errors and ServerErrorException on 5xx errors).

2.0.1 - 2025/07/30

  • Supports for any currency. (But not multi-currency)
  • Change on transaction history table
  • Add unit tests
  • Bug fixes

1.0.3 - 2025/07/11

  • New: Added a GitHub Action for building and releasing distributions.
  • New: Implement up to service layers logging.
  • New: Cache attachments after download until app closed.
  • Changed: Switched the jdkDownload source to a custom JDK and JavaFX bundle.
  • Changed: Jumped the major version to 1 to ensure compatibility with macOS.

0.39.0 - 2025/07/09

  • Update java version 17 to java 21
  • Update gradle version 8.2 to 8.10
  • Change packaging plugin from org.beryx.jlink to com.dua3.gradle.runtime
  • Write (working) packaging task for windows with badass-runtime
  • Write untested packaging task for macos and linux

About

Fireporter is a third-party app for Firefly III, it uses Firefly's API to download your financial records and process it to a PDF file.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages