firefly-iii/spectre-importer

Firefly III SaltEdge Spectre Importer Tool.


README

Packagist License Stargazers Donate



Firefly III

Firefly III Salt Edge / Spectre importer

A tool to import from Salt Edge / Spectre into Firefly III.
Explore the docs »

View Firefly III demo · Report Bug · Request Feature

About the Firefly III Salt Edge / Spectre importer

This is a tool to import from Salt Edge / Spectre files into Firefly III. It works by using a personal access token to access your Firefly III installation's API. It will then create transactions downloaded from your bank through the Spectre API.

The Spectre API is a product by fintech company Salt Edge. It is one of the few API's that I know of with a (semi) free tier that can connect to a lot of banks. Technically speaking, the Spectre API isn't actually meant for this use case: it's a business service designed for people who build financial services like Mint.com or YNAB. Or maybe, you're building an iPhone app? Then Salt Edge is something for you.

For us mortals however, we can use Spectre's free tier to connect to our bank since it's inside of the limit that Salt Edge puts on free accounts. The last I heard though, Spectre has a time limit of 90 days.

Purpose

Use this tool to (automatically) import from your bank into Firefly III using the Spectre API. If you're a bit of a developer, feel free to use this code to generate your own import tool.

Features

  • This tool will let you download or generate a configuration file, so the next import will go faster.

Who's it for?

Anybody who uses Firefly III and wants to automatically import from their bank using the Spectre API.

Getting Started

You can use this tool in several ways.

  1. Install it on your server using composer.
  2. Use the Docker-image.

Generally speaking, it's easiest to use and install this tool the same way as you use Firefly III. And although it features an excellent web-interface, you can also use the command line to import your data. There are upgrade instructions for both methods of installation.

The full usage instructions can be found in the documentation. Basically, this is the workflow:

Using the web interface

  1. Set up and configure your Personal Access Token and Firefly III URL.
  2. Create a new connection to your bank or select an existing connection.
  3. Configure the import parameters.
  4. Map values in the spectre file to existing values in your database.
  5. Enjoy the result in Firefly III.

Using the auto-import

  1. Import at least once, so you'll have a configuration file.
  2. Run the Docker inline import command

Known import challenges

Most people run into the same problems when importing data into Firefly III. Read more about those on the following pages:

  1. Issues with your Personal Access Token
  2. Often seen errors and issues.
  3. Frequently asked questions.

Other stuff

Contribute

Your help is always welcome! Feel free to open issues, ask questions, talk about it and discuss this tool. You can also join reddit or follow me on Twitter.

Of course, there are some contributing guidelines and a code of conduct, which I invite you to check out.

For all other contributions, see below.

Support the development of Firefly III and the Spectre API import tool

If you like this tool and if it helps you save lots of money, why not send me a dime for every dollar saved!

OK that was a joke. You can donate using PayPal, Patreon or the GitHub Sponsors Program.

This work is licensed under the GNU Affero General Public License v3.

Contact

You can contact me at james@firefly-iii.org, you may open an issue or contact me through the various social media pages there are: reddit and Twitter.

Scrutinizer Requires PHP7.4 Quality Gate Status