# Firefly III documentation ## Documentation - [Firefly III documentation](https://sourcey-firefly.pages.dev/index.md): Welcome. This site contains all the documentation for Firefly III and the Data Importer. Please follow the links below or use the top navigation bar to go to the section of your choice. When in doubt, please use the search bar in the top right-hand corner. - [Tutorials](https://sourcey-firefly.pages.dev/tutorials/index.md): Check out the following tutorials for Firefly III and the Data Importer. - [My first accounts](https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/index.md): Let's assume you managed to install Firefly III using the how-to guides. You've got a working installation, and you're ready to go. What's next? - [Create accounts and transactions](https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/index.md): Let's assume you managed to install Firefly III using the how-to guides - [Manage a subscription](https://sourcey-firefly.pages.dev/tutorials/finances/subscription/index.md): In the left-hand menu, go to Subscriptions, and press "Create new subscription". You can also use the right-hand menu, where you can press "Create subscription". - [Process a refund](https://sourcey-firefly.pages.dev/tutorials/finances/refund/index.md): This also applies to friends who pay you back (part of) an expense. Do you want to shrink the original expense or do you want to keep the whole expense and use the money as income? - [Manage your mortgage](https://sourcey-firefly.pages.dev/tutorials/finances/mortgage/index.md): There are multiple ways to manage your mortgage in Firefly III. The method illustrated on this page focuses on ensuring that all transactions are part of a budget, and categorized. - [Manage multiple currencies](https://sourcey-firefly.pages.dev/tutorials/finances/currencies/index.md): Firefly III supports many currencies, and you can add custom currencies as well. This tutorial explains something about it and also shows you the system's quirks when doing so. - [Importing data](https://sourcey-firefly.pages.dev/tutorials/firefly-iii/importing-data/index.md): (TODO link to other tutorials) - [Exporting data](https://sourcey-firefly.pages.dev/tutorials/firefly-iii/exporting-data/index.md): (TODO write tutorial structure and incorporate info below) - [Import a basic CSV file](https://sourcey-firefly.pages.dev/tutorials/data-importer/csv/index.md): Browse to importer, select CSV, upload a CSV file. - [Import a CAMT.05x file](https://sourcey-firefly.pages.dev/tutorials/data-importer/camt/index.md): Import a CAMT.05x file - [What are data providers?](https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/index.md): When you are managing your finances with Firefly III, you don't want to enter all your transactions manually. The data importer can help you with that. It can import CSV files and CAMT.05x files which are provided by most (if not all) banks to import data into Firefly III. - [basiq.io](https://sourcey-firefly.pages.dev/tutorials/data-importer/basiq/index.md): I have not yet finished the integration for this data provider. Once I have, the tutorial will follow. - [Enable Banking](https://sourcey-firefly.pages.dev/tutorials/data-importer/eb/index.md): Enable Banking is a European open banking aggregator that connects to 2500+ banks across 29 European countries using official PSD2 APIs. This tutorial guides you through setting up Enable Banking with the Firefly III Data Importer. - [FinTS](https://sourcey-firefly.pages.dev/tutorials/data-importer/fints/index.md): I have not yet finished the integration for this data provider. Once I have, the tutorial will follow. - [Import from GoCardless](https://sourcey-firefly.pages.dev/tutorials/data-importer/gocardless/index.md): My apologies, in this screenshot it is still called "Nordigen". - [Sophtron](https://sourcey-firefly.pages.dev/tutorials/data-importer/sophtron/index.md): Sophtron is a platform that offers (among many other things) a collection of financial data aggregation APIs, that connect you to a large collection of US, Canadian and Mexican banks. Sophtron is free for individual developers and personal use, as is detailed in their developer agreement. The Sophtron API is available… - [Lunch Flow](https://sourcey-firefly.pages.dev/tutorials/data-importer/lunchflow/index.md): Lunch Flow is a paid provider that can connect to many banks through a bunch of APIs they maintain. This tutorial assumes you have signed up etc. - [Open Banking Data (HBCI)](https://sourcey-firefly.pages.dev/tutorials/data-importer/obg/index.md): I have not yet finished the integration for this data provider. Once I have, the tutorial will follow. - [SimpleFIN imports using the data importer](https://sourcey-firefly.pages.dev/tutorials/data-importer/simplefin/index.md): SimpleFIN is a service that allows you to import financial data from various banks into Firefly III. You can read more about SimpleFIN on their website. - [teller.io](https://sourcey-firefly.pages.dev/tutorials/data-importer/teller/index.md): I have not yet finished the integration for this data provider. Once I have, the tutorial will follow. - [How-to guides](https://sourcey-firefly.pages.dev/how-to/index.md): These how-to guides will show you how to do things. The guides are goal oriented and will get you to a specific point. - [How to debug Firefly III?](https://sourcey-firefly.pages.dev/how-to/general/debug/index.md): If you believe you found a bug in Firefly III, or if you need help with the data importer, you can enable debug mode. In debug mode you can see exactly what the error is. This can prove useful when trying to find the source of a bug. - [How to report security issues](https://sourcey-firefly.pages.dev/how-to/general/report-security-issues/index.md): The latest instructions are in the security policy. Please follow those instructions closely. - [How to install Firefly III using Docker](https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/docker/index.md): Firefly III can be installed using Docker. There are ready-made Docker containers for almost all platforms. If you've never used Docker before, please first read into it yourself. - [Installation using Portainer](https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/portainer/index.md): Portainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes. - [Kubernetes](https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/kubernetes/index.md): In the GitHub repository you will find a bunch of YAML files that denote a pretty standard service offering for both Firefly III and an accompanying MySQL database. - [Self-managed server](https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/self-managed/index.md): If you have your own (virtual) web server you can use this guide to install Firefly III. You may have some ingredients prepared already. - [Third party hosting](https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/hosted/index.md): There are several parties that offer Firefly III hosting. This is of course very much "in the cloud", but these providers generally offer EU-based cloud hosting, back-ups and all kinds of other services that a growing person needs to manage their finances. - [How to upgrade Firefly III](https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/docker/index.md): Firefly III can upgrade itself from very old versions, even back from 4.7.x. In some cases the upgrade process is destructive. It will remove transactions, delete accounts or clean up data. - [Kubernetes](https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/kubernetes/index.md): In the GitHub repository you will find a bunch of YAML files that denote a pretty standard service offering for both Firefly III and an accompanying MySQL database. - [Upgrade a self-managed server](https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/self-managed/index.md): Firefly III can upgrade itself from very old versions, even back from 4.7.x. In some cases the upgrade process is destructive. It will remove transactions, delete accounts or clean up data. - [How to set up notifications and emails](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/notifications/index.md): Firefly III can send notifications for specific events. Check out /settings/notifications and /preferences for a set of notifications you can receive. - [How to use different authentication](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/authentication/index.md): By default, Firefly III uses a basic system that allows users to register and login locally. This is based on the user's email address. - [How to make a backup](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/index.md): Firefly III does not come with a built-in backup routine. Using your native OS tools is way more useful and faster. - [How to set up your local language](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/locales/index.md): The locale you want to use is identified by a little piece of text, like this: en, English, en_US.utf8. - [Cron jobs](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/cron/index.md): Firefly III has several feature that will only work when the cron job is running. Automated budgets, recurring transactions, subscription warnings and up-to-data currency exchange rate information all need a working cron job to function properly. - [How to manage accounts](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/accounts/index.md): Although there's plenty of variation that you can apply here, this is how I recommend you manage accounts. - [How to manage budgets](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/budgets/index.md): Firefly III features budgets as a powerful way to manage your finances. To get started, visit the /budgets page and create your first budget. Just enter a name for now, nothing else. - [How to organize transactions](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/index.md): Transactions are, naturally, the core of how you manage your finances. You can create transactions manually or have them imported by the data importer. - [How to track cash](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/cash/index.md): There are a few ways to manage your cash transactions in Firefly III. On this page you can read about them. - [How to use subscriptions?](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/subscriptions/index.md): In Firefly III a "subscription" is a record of a subscription or a recurring bill that you need to pay, like your rent or a Spotify subscription. You can read more about it in the explanation about subscriptions. - [How to reconcile accounts](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reconcile/index.md): Although more and more people use online banking, a lot of users still receive paper bank statements in the mail, every week or every month. Firefly III has a "reconciliation" view that allows you to verify that your transactions exactly match your bank statement. This can also help to resolve incorrect balances after… - [How to manage liabilities](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/liabilities/index.md): ( TODO write me) - [How to use recurring transactions](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/recurring/index.md): Firefly III can automatically create transactions for you, if they follow a tight schedule, like every month, week or year. - [How to use piggy banks](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/piggy-banks/index.md): Firefly III features "piggy banks". Piggy banks are a way to divide a savings account in a number of parts, and divide the money among these parts. You can read more about them on the page that explains piggy banks. - [How to read reports](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reports/index.md): This way you can create the exact cross-section of your finances you need. - [How to make Firefly III multi-user?](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/multi-user/index.md): Firefly III supports an unlimited amount of users, who all have their own financial administration, completely separated from other users. - [How to use rules](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/rules/index.md): Firefly III contains a powerful rule engine that can automatically update your transactions. It can do this when transactions are created or when they are changed. It works by combining "triggers" with "actions". - [How to use expressions in rules?](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/expressions/index.md): Once you've learned how to use rules, you may think that rule actions are pretty plain. You can update some fields, but it's all pretty static. That's where expressions come in. - [Webhooks](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/webhooks/index.md): A webhook is a custom callback. Triggered by events in Firefly III a message will be sent to a URL of your choice. - [How to use the search](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/search/index.md): You can search for transactions using the box in the left top of the page. The search engine is pretty powerful and can find almost anything, but it is not yet as user-friendly as it could be. My apologies in advance. - [How to use currencies](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/currencies/index.md): Firefly III has support for multiple currencies. - [CLI / Command Line Interface](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/cli/index.md): Firefly III has a few commands you can use. See this reference to a list of commands. - [How to use the API](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md): The Firefly III API is a REST-based JSON API that you can use to talk to (almost) every aspect of Firefly III. If you're interested you can read the full spec. - [Translating Firefly III](https://sourcey-firefly.pages.dev/how-to/firefly-iii/development/translations/index.md): First of all, thank you for taking the time to help get Firefly III translated in as many languages as possible. Translation work is tedious and concentrated work, and I appreciate all your efforts. To make translating Firefly III as easy as possible I wrote this little guide to get you started. - [How to install using Docker](https://sourcey-firefly.pages.dev/how-to/data-importer/installation/docker/index.md): Firefly III and the Data Importer can be installed using Docker. There are ready-made Docker containers for almost all platforms. If you've never used Docker before, please first read into it yourself. - [Installation using Portainer](https://sourcey-firefly.pages.dev/how-to/data-importer/installation/portainer/index.md): Portainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes. - [Using Kubernetes](https://sourcey-firefly.pages.dev/how-to/data-importer/installation/kubernetes/index.md): In the GitHub repository you will find a bunch of YAML files that denote a pretty standard service offering for Firefly III, the Data Importer and an accompanying MySQL database. - [Self-managed server](https://sourcey-firefly.pages.dev/how-to/data-importer/installation/self-managed/index.md): If you have your own (virtual) web server you can use this guide to install the Firefly III Data Importer. You may have some ingredients prepared already. - [How to configure the data importer](https://sourcey-firefly.pages.dev/how-to/data-importer/how-to-configure/index.md): The Data Importer communicates with Firefly III over the API. - [Upgrade using Docker](https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/docker/index.md): This page gives you instructions on how to upgrade your Data Importer installation. - [Using Kubernetes](https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/kubernetes/index.md): In the GitHub repository you will find a bunch of YAML files that denote a pretty standard service offering for Firefly III, the Data Importer and an accompanying MySQL database. - [Upgrade a self-managed server](https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/self-managed/index.md): The best way to upgrade is to use the "Straight from GitHub" instructions below. In recent times, the deployment of the Firefly III Data Importer has changed and the "create-project" method is no longer recommended. - [How to import files](https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/index.md): A short how-to guide on how to import files using the Data Importer. This guide assumes you have the Data Importer working and running. - [How to do automated imports](https://sourcey-firefly.pages.dev/how-to/data-importer/import/automated/index.md): In the Data Importer, run through the import and download the configuration file. Put the JSON-file in the import folder you created and bound to the container. Be sure to name it config.json. The name can be anything though. - [How to manage JSON configuration files](https://sourcey-firefly.pages.dev/how-to/data-importer/import/json/index.md): The Data Importer uses JSON files that store your configuration. Once you are happy with your import configuration, you can run the import again and again using the same configuration file. This how-to explains how to do that. - [How to map data](https://sourcey-firefly.pages.dev/how-to/data-importer/import/map-data/index.md): Any time you import data, you'll see that your bank tends to deliver messy transactions. The shop names are a riddle, and the descriptions are very strange. Often the only thing that's correct is the amount. - [How to use third party data providers?](https://sourcey-firefly.pages.dev/how-to/data-importer/import/third-party-providers/index.md): The Firefly III data importer supports several third party data providers to help you import your financial data into Firefly III. - [How to import transfers between accounts](https://sourcey-firefly.pages.dev/how-to/data-importer/import/transfers/index.md): The first time you import data you may run into an issue where the Firefly III data importer creates withdrawals and deposits instead of transfers. Your import will contain transfers, deposits and expenses of them but somehow all you end up with expenses and deposits only. This is a common issue and is caused by the… - [How to handle (missed) duplicates](https://sourcey-firefly.pages.dev/how-to/data-importer/import/duplicates/index.md): Sometimes the Data Importer will create duplicate transactions, despite being told not to. Some other times the Data Importer refuses to import a transaction because it claims to be a duplicate transaction. - [How to use GoCardless](https://sourcey-firefly.pages.dev/how-to/data-importer/import/gocardless/index.md): The GoCardless API is free-to-use for Firefly III users. The GoCardless product however is paid, and they are a commercial organization. Furthermore, the API access for Firefly III users may be limited. - [How to use Spectre Salt Edge](https://sourcey-firefly.pages.dev/how-to/data-importer/import/salt-edge/index.md): How to use Spectre Salt Edge - [How to use SimpleFIN](https://sourcey-firefly.pages.dev/how-to/data-importer/import/simplefin/index.md): To read more, please check out this tutorial. - [How to import using the CLI](https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/cli/index.md): The Data Importer can import from the command line. Either by calling the Docker container, or by using your self-managed instance. - [How to import using HTTP POST](https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/post/index.md): You can use the data importer's POST commands to import data. This page assumes you're self-managing the data importer, although these commands also work when using Docker. - [How to set up notifications and emails](https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/notifications/index.md): The data importer can email you the results of the import. This is useful for cron jobs. - [How to set a custom import tag](https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/custom-import-tag/index.md): You can set a custom import tag, either in your configuration file or using the UI. - [Reference guides](https://sourcey-firefly.pages.dev/references/index.md): These pages will give you more information on the (inner) workings of Firefly III, the API and other things. - [Command line / CLI](https://sourcey-firefly.pages.dev/references/firefly-iii/cli/index.md): Firefly III has a bunch of CLI commands that you can use. Generally speaking these are meant for large operations. Here's a full overview. - [Account types](https://sourcey-firefly.pages.dev/references/firefly-iii/account-types/index.md): These are the account types in Firefly III. - [Transaction types](https://sourcey-firefly.pages.dev/references/firefly-iii/transaction-types/index.md): Withdrawals are meant to record expenses. The source account of each withdrawal is an asset account, and the destination account is an expense account. - [Search](https://sourcey-firefly.pages.dev/references/firefly-iii/search/index.md): The search engine will search in the description of transactions only. Other filters are possible, and are listed below. - [Rule triggers](https://sourcey-firefly.pages.dev/references/firefly-iii/rule-triggers/index.md): The Firefly III rule engine can trigger on a number of things. If you are missing a specific trigger, please check out the support page. - [Rule actions](https://sourcey-firefly.pages.dev/references/firefly-iii/rule-actions/index.md): Here's a summary of the rule actions you can use. - [Rule expressions](https://sourcey-firefly.pages.dev/references/firefly-iii/rule-expressions/index.md): Firefly III features a powerful rule engine that comes with an expression language to execute actions on your transactions. - [API](https://sourcey-firefly.pages.dev/references/firefly-iii/api/index.md): Firefly III features a JSON API. - [API special endpoints](https://sourcey-firefly.pages.dev/references/firefly-iii/api/specials/index.md): Some Firefly III API endpoints need a little more guidance than fits in the documentation. - [Third parties that host Firefly III](https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/host/index.md): Firefly III is available on Hostinger. - [Third-party apps](https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/apps/index.md): There are a lot of interesting tools and apps built around the Firefly III API. Here's a list, in no particular order. Is your (favorite) tool not on the list? Submit a PR! - [Change Log](https://sourcey-firefly.pages.dev/references/firefly-iii/changelog/index.md): All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. - [JSON configuration file](https://sourcey-firefly.pages.dev/references/data-importer/json/index.md): The data importer generates an import configuration file each time you import data. You can download the configuration file during or after the import. - [Data field roles](https://sourcey-firefly.pages.dev/references/data-importer/roles/index.md): The data importer can import a lot of data. This page lists all the roles that a column can have. You can use this page to validate your CSV file. - [Third-party tools](https://sourcey-firefly.pages.dev/references/data-importer/third-party-tools/index.md): There are various scripts and tools you can use, if the Firefly III Data Importer does not fit your use case. - [Public installation](https://sourcey-firefly.pages.dev/references/data-importer/public/index.md): There is a public (cloud-based) instance of the Firefly III Data Importer running on https://data-importer.firefly-iii.org that anybody can use. - [Duplicate detection](https://sourcey-firefly.pages.dev/references/data-importer/duplicate-detection/index.md): The data importer will not import the same transaction twice, because that would be annoying for the user. This is accomplished by a trick called "duplicate detection". For each transaction that is about to be imported, the data importer will first see if it exists already in Firefly III. If a duplicate exists, it… - [Change Log](https://sourcey-firefly.pages.dev/references/data-importer/changelog/index.md): All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. - [General Firefly III questions](https://sourcey-firefly.pages.dev/references/faq/firefly-iii/general/index.md): Yes. For security reasons Firefly III opens up the registration form only for the first user. See also how to make Firefly III multi-user. Keep in mind that you won't be able to share your administration. This is a work in progress. - [Using Firefly III, questions](https://sourcey-firefly.pages.dev/references/faq/firefly-iii/using/index.md): Press the little red icon in the top menu bar, or disable "Hidden amounts" in your /preferences. - [Firefly III personal finance questions](https://sourcey-firefly.pages.dev/references/faq/firefly-iii/finances/index.md): This is not a bug, this is the correct behavior. Adding money to a piggy bank based on a transaction is a one-time action. It cannot be repeated. If you edit the transaction, the action will not be repeated. - [General Data Importer questions](https://sourcey-firefly.pages.dev/references/faq/data-importer/general/index.md): Sorry about that. You'll have to consult the data importer log files. Please look at the debug instructions for the data importer. The log files will show you what the error is. With that information, you can come find us for some support, so we can fix it together. - [Common data import issues and questions](https://sourcey-firefly.pages.dev/references/faq/data-importer/import/index.md): If your bank formats numbers like 3.000 (for "three thousand") and like this: 3.123,12 (for "three thousand one hundred..."), you can set FALLBACK_LOCALE=de_DE in your environment variables. This should allow the data importer to recognize the numbers properly. - [GoCardless](https://sourcey-firefly.pages.dev/references/faq/data-importer/gocardless/index.md): The data importer will check first if the transaction with a specific "external ID" already exists. When it does, it will not be imported again. Not even when you deleted. However, this check on deleted transactions may fail. Or rather, you may have inadvertently turned it off. But you can turn it on again! - [General questions and answers](https://sourcey-firefly.pages.dev/references/faq/general/index.md): Some questions don't really fit anywhere, so I have put them in this section. - [General installation and running questions](https://sourcey-firefly.pages.dev/references/faq/install/index.md): No you cannot. URLs in the form of http(s)://[ab:cd:etc]/ are not parsed correctly by Laravel and they refuse to fix this. I am working on a hack, but don't hold your breath. - [Development](https://sourcey-firefly.pages.dev/references/faq/development/index.md): If you want to contribute to the development of Firefly III, first of all: thank you! - [FAQ for Docker-related questions](https://sourcey-firefly.pages.dev/references/faq/docker/index.md): Yes, but keep in mind that Docker (Swarm) secrets may not work because the container does not run as root. A possible solution is outlined in this Docker Community Forums discussion and detailed in this GitHub discussion. - [Support](https://sourcey-firefly.pages.dev/explanation/support/index.md): If you found a bug, have a feature request or another idea for improvements, please open an issue on GitHub. - [Explanation](https://sourcey-firefly.pages.dev/explanation/index.md): If you want to know more about Firefly III or the Data Importer in general, or you're just browsing around, check out the menu on the left. - [Best practices](https://sourcey-firefly.pages.dev/explanation/data-classification/best-practices/index.md): Depending on what financial application you're used to organizing your data with, you will find that Firefly III can be a little bit different. - [Data classification](https://sourcey-firefly.pages.dev/explanation/data-classification/what-to-use/index.md): In order to make sure you organize your transactions right, use the following guidelines to make sure the granularity of your transactions (and other data) is correct. - [Financial administrations](https://sourcey-firefly.pages.dev/explanation/financial-concepts/administrations/index.md): Firefly III is working towards support for multiple financial administrations. This means that you will be able to keep track of multiple separated financial sets of data. For example, you could manage your personal finances and the finances you share with your partner in the same Firefly III installation. - [Transactions](https://sourcey-firefly.pages.dev/explanation/financial-concepts/transactions/index.md): Each transaction is stored twice. Once as a loss (for one party), and once as a profit (for the other party). This seems pretty pointless, and technically it is. But it was designed back when clerks could be fraudulent and this double-entry system stopped fraud. In these modern days it is useful to check if all… - [Accounts](https://sourcey-firefly.pages.dev/explanation/financial-concepts/accounts/index.md): And many more subjects under the how-to and tutorial sections. - [Budgets](https://sourcey-firefly.pages.dev/explanation/financial-concepts/budgets/index.md): Budgets are an important part of Firefly III and an important way to keep track of your finances. In the core, a budget is just another identifier to link withdrawals (only withdrawals) together. Often used budgets are "Groceries" or "Bills". To make budgets more useful, you can assign a date range and an amount to a… - [Liabilities](https://sourcey-firefly.pages.dev/explanation/financial-concepts/liabilities/index.md): A liability is a debt: either money you owe or money that is owed to you. In Firefly III you can track both of these. - [Currencies](https://sourcey-firefly.pages.dev/explanation/financial-concepts/currencies/index.md): Firefly III supports as many currencies as you like. By default, it ships with a variety of currencies. You can add your own currencies if you're missing one. The currency code must be compliant with ISO 4217. - [Piggy banks](https://sourcey-firefly.pages.dev/explanation/financial-concepts/piggy-banks/index.md): To learn how to manage piggy banks, please read how to manage piggy banks. - [Subscriptions](https://sourcey-firefly.pages.dev/explanation/financial-concepts/subscriptions/index.md): You can keep an eye on your expected recurring expenses by creating subscriptions. Things like rent and utilities must be paid every month and Firefly III can keep track of such things. - [Recurring transactions](https://sourcey-firefly.pages.dev/explanation/financial-concepts/recurring/index.md): Firefly III features the ability to automatically create transactions, so you don't have to. These are called recurring transactions. - [Exchange rate](https://sourcey-firefly.pages.dev/explanation/financial-concepts/exchange-rates/index.md): Firefly III can dynamically convert amounts from one currency into another using exchange rates. You can set the exchange rates yourself or allow Firefly III to download exchange rates for you. - [Firefly III introduction](https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/introduction/index.md): "Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. - [Screenshots](https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/screenshots/index.md): Check it out yourself on the demo site. - [Demo website](https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/demo/index.md): Before you even install Firefly III, consider checking out the Firefly III demo website to get a feel for the product. - [Managing your personal finances](https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/personal-finances/index.md): This is a description of how Firefly III works, and how I feel about personal finances. - [Zero based budgeting](https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/zero-based-budgeting/index.md): Zero based budgeting is a method of budgeting that focuses on giving each Euro a goal. All your budgets start at zero, and you fill them with money. Expenses deplete budgets until you make money to fill the budgets. I believe this approach is pretty terrible. - [Time periods](https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/time-periods/index.md): Firefly III shows you your finances per month. In your settings you can change this. For example, you can choose to show your finances yearly, weekly or in a "month to date"-style. More options exist of course, just check out your settings. - [Firefly III Data Importer](https://sourcey-firefly.pages.dev/explanation/data-importer/introduction/index.md): The Firefly III data importer can be used to import data into Firefly III. It is a separate tool from Firefly III with its own installation and upgrade guides. - [Separate tool](https://sourcey-firefly.pages.dev/explanation/data-importer/separate-tool/index.md): I turned the data importer into a separate tool. It allows me to keep track of two different tools with different development requirements. - [Ignored values](https://sourcey-firefly.pages.dev/explanation/data-importer/ignored-values/index.md): The data importer will do this when both the source and destination account information of a transaction are the same. This may happen when you get credit card refunds, when interest is paid to your account or when interest payments are taken from your account. - [Firefly III logo and name](https://sourcey-firefly.pages.dev/explanation/more-information/logo/index.md): The name of this tool is "Firefly III". It was named after the Fairey Firefly because at the time all my project names were British airplanes from the WW2 era. - [Architecture](https://sourcey-firefly.pages.dev/explanation/more-information/architecture/index.md): On this page you'll find information about the internal architecture of Firefly III. It's not meant as an explanation of where everything is but rather as a means to show you how everything is structured. If you ever want to develop something these pages should show you where you need be. - [Firefly III security](https://sourcey-firefly.pages.dev/explanation/more-information/security/index.md): Because Firefly III stores personal financial information it's important to know how Firefly III is secured, and how it's not. - [The Firefly III license](https://sourcey-firefly.pages.dev/explanation/more-information/license/index.md): Firefly III, the Firefly III Data Importer and any and all associated tools developed by me are licensed to you under the GNU Affero General Public License v3. It's abbreviated as "AGPLv3". - [Financial contributions](https://sourcey-firefly.pages.dev/explanation/more-information/donations/index.md): Firefly III is built by "James Cole" and all contributors, for free. It's free software, both in the sense that it doesn't cost anything, and free software in the sense that it's free to edit, change or use it as you wish, under the terms of the AGPLv3 license. I am however, not adverse to a donation or a sponsorship. - [What Firefly III isn't](https://sourcey-firefly.pages.dev/explanation/more-information/what-its-not/index.md): Even more important than all the stuff Firefly III can do for you is the list of stuff it can't do for you. If you're looking for a personal finance tool to do this for you, you may want to consider using another tool. This is unfortunate, but the result of some architecture and design choices. My apologies in… - [(Security) testing](https://sourcey-firefly.pages.dev/explanation/more-information/bending-and-breaking/index.md): You are always welcome to see if you can find security problems in Firefly III. Many have been found before, and I'm sure many are still left in the code somewhere. - [Signed release files](https://sourcey-firefly.pages.dev/explanation/more-information/signatures/index.md): Both the Firefly III and Data Importer releases are digitally signed. - [Other Firefly III related tools](https://sourcey-firefly.pages.dev/explanation/other-tools/index.md): There are a number of Firefly III tools and libraries you can check out and use, which are made by me. - [Contributor Covenant Code of Conduct](https://sourcey-firefly.pages.dev/explanation/code-of-conduct/index.md): In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience,… - [Contributing to Firefly III](https://sourcey-firefly.pages.dev/explanation/contributing/index.md): Thank you so much for wanting to help make Firefly III better! ## API Reference - [Firefly III API](https://sourcey-firefly.pages.dev/api/index.md): The Firefly III REST API: every endpoint of Firefly III v6.7.8. Requests go to /api on your own installation. How to use the API shows how to create the OAuth client or Personal Access Token they need, and the API reference guide explains the currency fields, configuration values and webhooks. - [Returns all accounts of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getaccountsac/index.md): GET /v1/autocomplete/accounts: returns AutocompleteAccountArray. - [Returns all bills of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getbillsac/index.md): GET /v1/autocomplete/bills: returns AutocompleteBillArray. - [Returns all budgets of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getbudgetsac/index.md): GET /v1/autocomplete/budgets: returns AutocompleteBudgetArray. - [Returns all categories of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getcategoriesac/index.md): GET /v1/autocomplete/categories: returns AutocompleteCategoryArray. - [Returns all currencies of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getcurrenciesac/index.md): GET /v1/autocomplete/currencies: returns AutocompleteCurrencyArray. - [Returns all object groups of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getobjectgroupsac/index.md): GET /v1/autocomplete/object-groups: returns AutocompleteObjectGroupArray. - [Returns all piggy banks of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getpiggiesac/index.md): GET /v1/autocomplete/piggy-banks: returns AutocompletePiggyBalanceArray. - [Returns all recurring transactions of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getrecurringac/index.md): GET /v1/autocomplete/recurring: returns AutocompleteRecurrenceArray. - [Returns all rule groups of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getrulegroupsac/index.md): GET /v1/autocomplete/rule-groups: returns AutocompleteRuleGroupArray. - [Returns all rules of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getrulesac/index.md): GET /v1/autocomplete/rules: returns AutocompleteRuleArray. - [Returns all subscriptions of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/getsubscriptionsac/index.md): GET /v1/autocomplete/subscriptions: returns AutocompleteBillArray. - [Returns all tags of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/gettagac/index.md): GET /v1/autocomplete/tags: returns AutocompleteTagArray. - [Returns all transaction types returned in a basic auto-complete array. English only.](https://sourcey-firefly.pages.dev/api/gettransactiontypesac/index.md): GET /v1/autocomplete/transaction-types: returns AutocompleteTransactionTypeArray. - [Returns all transaction descriptions of the user returned in a basic auto-complete array.](https://sourcey-firefly.pages.dev/api/gettransactionsac/index.md): GET /v1/autocomplete/transactions: returns AutocompleteTransactionArray. - [Returns all transactions, complemented with meta information.](https://sourcey-firefly.pages.dev/api/gettransactionswithmeta/index.md): GET /v1/autocomplete/transactions-with-meta: returns AutocompleteTransactionWithMetaArray. - [Dashboard chart with asset account balance information.](https://sourcey-firefly.pages.dev/api/getchartaccountoverview/index.md): This endpoint returns the data required to generate a chart with basic asset account balance information. This is used on the dashboard. - [Dashboard chart with balance information.](https://sourcey-firefly.pages.dev/api/getchartbalance/index.md): This endpoint returns the data required to generate a chart with balance information. - [Dashboard chart with budget information.](https://sourcey-firefly.pages.dev/api/getchartbudgetoverview/index.md): This endpoint returns the data required to generate a chart with basic budget information. - [Dashboard chart with budget and budget limit information.](https://sourcey-firefly.pages.dev/api/getchartbudgetoverviewwithlimits/index.md): This endpoint returns the data required to generate a chart with basic budget information, grouped by budget limit when necessary. - [Dashboard chart with category information.](https://sourcey-firefly.pages.dev/api/getchartcategoryoverview/index.md): This endpoint returns the data required to generate a chart with basic category information. - [Bulk update transaction properties](https://sourcey-firefly.pages.dev/api/bulkupdatetransactions/index.md): Allows you to update transactions in bulk. For more information, see Bulk transaction update. - [Endpoint to destroy user data](https://sourcey-firefly.pages.dev/api/destroydata/index.md): A call to this endpoint deletes the requested data type. Use it with care and always with user permission. The demo user is incapable of using this endpoint. - [Export account data from Firefly III](https://sourcey-firefly.pages.dev/api/exportaccounts/index.md): This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only. - [Export bills from Firefly III](https://sourcey-firefly.pages.dev/api/exportbills/index.md): This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only. - [Export subscriptions from Firefly III](https://sourcey-firefly.pages.dev/api/exportsubscriptions/index.md): This endpoint allows you to export your subscriptions (also known as bills) from Firefly III into a file. Currently supports CSV exports only. - [Export budgets and budget amount data from Firefly III](https://sourcey-firefly.pages.dev/api/exportbudgets/index.md): This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only. - [Export category data from Firefly III](https://sourcey-firefly.pages.dev/api/exportcategories/index.md): This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only. - [Export piggy banks from Firefly III](https://sourcey-firefly.pages.dev/api/exportpiggies/index.md): This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only. - [Export recurring transaction data from Firefly III](https://sourcey-firefly.pages.dev/api/exportrecurring/index.md): This endpoint allows you to export your recurring transactions from Firefly III into a file. Currently supports CSV exports only. - [Export rule groups and rule data from Firefly III](https://sourcey-firefly.pages.dev/api/exportrules/index.md): This endpoint allows you to export your rules and rule groups from Firefly III into a file. Currently supports CSV exports only. - [Export tag data from Firefly III](https://sourcey-firefly.pages.dev/api/exporttags/index.md): This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only. - [Export transaction data from Firefly III](https://sourcey-firefly.pages.dev/api/exporttransactions/index.md): This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only. - [Endpoint to purge user data](https://sourcey-firefly.pages.dev/api/purgedata/index.md): A call to this endpoint purges all previously deleted data. Use it with care and always with user permission. The demo user is incapable of using this endpoint. - [Insight into expenses, grouped by expense account.](https://sourcey-firefly.pages.dev/api/insightexpenseexpense/index.md): This endpoint gives a summary of the expenses made by the user, grouped by expense account. - [Insight into expenses, grouped by asset account.](https://sourcey-firefly.pages.dev/api/insightexpenseasset/index.md): This endpoint gives a summary of the expenses made by the user, grouped by asset account. - [Insight into income, grouped by revenue account.](https://sourcey-firefly.pages.dev/api/insightincomerevenue/index.md): This endpoint gives a summary of the income received by the user, grouped by revenue account. - [Insight into income, grouped by asset account.](https://sourcey-firefly.pages.dev/api/insightincomeasset/index.md): This endpoint gives a summary of the income received by the user, grouped by asset account. - [Insight into transfers, grouped by account.](https://sourcey-firefly.pages.dev/api/insighttransfers/index.md): This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability. - [Insight into expenses, grouped by bill.](https://sourcey-firefly.pages.dev/api/insightexpensebill/index.md): This endpoint gives a summary of the expenses made by the user, grouped by (any) bill. - [Insight into expenses, without bill.](https://sourcey-firefly.pages.dev/api/insightexpensenobill/index.md): This endpoint gives a summary of the expenses made by the user, including only expenses with no bill. - [Insight into expenses, grouped by budget.](https://sourcey-firefly.pages.dev/api/insightexpensebudget/index.md): This endpoint gives a summary of the expenses made by the user, grouped by (any) budget. - [Insight into expenses, without budget.](https://sourcey-firefly.pages.dev/api/insightexpensenobudget/index.md): This endpoint gives a summary of the expenses made by the user, including only expenses with no budget. - [Insight into expenses, grouped by category.](https://sourcey-firefly.pages.dev/api/insightexpensecategory/index.md): This endpoint gives a summary of the expenses made by the user, grouped by (any) category. - [Insight into expenses, without category.](https://sourcey-firefly.pages.dev/api/insightexpensenocategory/index.md): This endpoint gives a summary of the expenses made by the user, including only expenses with no category. - [Insight into income, grouped by category.](https://sourcey-firefly.pages.dev/api/insightincomecategory/index.md): This endpoint gives a summary of the income received by the user, grouped by (any) category. - [Insight into income, without category.](https://sourcey-firefly.pages.dev/api/insightincomenocategory/index.md): This endpoint gives a summary of the income received by the user, including only income with no category. - [Insight into transfers, grouped by category.](https://sourcey-firefly.pages.dev/api/insighttransfercategory/index.md): This endpoint gives a summary of the transfers made by the user, grouped by (any) category. - [Insight into transfers, without category.](https://sourcey-firefly.pages.dev/api/insighttransfernocategory/index.md): This endpoint gives a summary of the transfers made by the user, including only transfers with no category. - [Insight into expenses, grouped by tag.](https://sourcey-firefly.pages.dev/api/insightexpensetag/index.md): This endpoint gives a summary of the expenses made by the user, grouped by (any) tag. - [Insight into expenses, without tag.](https://sourcey-firefly.pages.dev/api/insightexpensenotag/index.md): This endpoint gives a summary of the expenses made by the user, including only expenses with no tag. - [Insight into income, grouped by tag.](https://sourcey-firefly.pages.dev/api/insightincometag/index.md): This endpoint gives a summary of the income received by the user, grouped by (any) tag. - [Insight into income, without tag.](https://sourcey-firefly.pages.dev/api/insightincomenotag/index.md): This endpoint gives a summary of the income received by the user, including only income with no tag. - [Insight into transfers, grouped by tag.](https://sourcey-firefly.pages.dev/api/insighttransfertag/index.md): This endpoint gives a summary of the transfers created by the user, grouped by (any) tag. - [Insight into expenses, without tag.](https://sourcey-firefly.pages.dev/api/insighttransfernotag/index.md): This endpoint gives a summary of the transfers made by the user, including only transfers with no tag. - [Insight into total expenses.](https://sourcey-firefly.pages.dev/api/insightexpensetotal/index.md): This endpoint gives a sum of the total expenses made by the user. - [Insight into total income.](https://sourcey-firefly.pages.dev/api/insightincometotal/index.md): This endpoint gives a sum of the total income received by the user. - [Insight into total transfers.](https://sourcey-firefly.pages.dev/api/insighttransfertotal/index.md): This endpoint gives a sum of the total amount transfers made by the user. - [List all transactions related to the account.](https://sourcey-firefly.pages.dev/api/listtransactionbyaccount/index.md): This endpoint returns a list of all the transactions connected to the account. - [Lists all attachments.](https://sourcey-firefly.pages.dev/api/listattachmentbyaccount/index.md): GET /v1/accounts/{id}/attachments: returns AttachmentArray. - [List all piggy banks related to the account.](https://sourcey-firefly.pages.dev/api/listpiggybankbyaccount/index.md): This endpoint returns a list of all the piggy banks connected to the account. - [List all accounts.](https://sourcey-firefly.pages.dev/api/listaccount/index.md): This endpoint returns a list of all the accounts owned by the authenticated user. - [Create new account.](https://sourcey-firefly.pages.dev/api/storeaccount/index.md): Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform). - [Get single account.](https://sourcey-firefly.pages.dev/api/getaccount/index.md): Returns a single account by its ID. - [Update existing account.](https://sourcey-firefly.pages.dev/api/updateaccount/index.md): Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. - [Permanently delete account.](https://sourcey-firefly.pages.dev/api/deleteaccount/index.md): Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from. - [List all attachments.](https://sourcey-firefly.pages.dev/api/listattachment/index.md): This endpoint lists all attachments. - [Store a new attachment.](https://sourcey-firefly.pages.dev/api/storeattachment/index.md): Creates a new attachment. The data required can be submitted as a JSON body or as a list of parameters. You cannot use this endpoint to upload the actual file data (see below). This endpoint only creates the attachment object. - [Get a single attachment.](https://sourcey-firefly.pages.dev/api/getattachment/index.md): Get a single attachment. This endpoint only returns the available metadata for the attachment. Actual file data is handled in two other endpoints (see below). - [Update existing attachment.](https://sourcey-firefly.pages.dev/api/updateattachment/index.md): Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below. - [Delete an attachment.](https://sourcey-firefly.pages.dev/api/deleteattachment/index.md): With this endpoint you delete an attachment, including any stored file data. - [Download a single attachment.](https://sourcey-firefly.pages.dev/api/downloadattachment/index.md): This endpoint allows you to download the binary content of a transaction. It will be sent to you as a download, using the content type "application/octet-stream" and content disposition "attachment; filename=example.pdf". - [Upload an attachment.](https://sourcey-firefly.pages.dev/api/uploadattachment/index.md): Use this endpoint to upload (and possible overwrite) the file contents of an attachment. Simply put the entire file in the body as binary data. - [List all available budget amounts.](https://sourcey-firefly.pages.dev/api/listavailablebudgets/index.md): Firefly III calculates the total amount of money budgeted in so-called "available budgets". This endpoint returns all of these amounts and the periods for which they are calculated. - [Get a single available budget.](https://sourcey-firefly.pages.dev/api/getavailablebudget/index.md): Get a single available budget, by ID. - [List all attachments uploaded to the bill.](https://sourcey-firefly.pages.dev/api/listattachmentbybill/index.md): This endpoint will list all attachments linked to the bill. - [List all rules associated with the bill.](https://sourcey-firefly.pages.dev/api/listrulebybill/index.md): This endpoint will list all rules that have an action to set the bill to this bill. - [List all transactions associated with the bill.](https://sourcey-firefly.pages.dev/api/listtransactionbybill/index.md): This endpoint will list all transactions linked to this bill. - [List all bills.](https://sourcey-firefly.pages.dev/api/listbill/index.md): This endpoint will list all the user's bills. - [Store a new bill](https://sourcey-firefly.pages.dev/api/storebill/index.md): Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single bill.](https://sourcey-firefly.pages.dev/api/getbill/index.md): GET /v1/bills/{id}: returns BillSingle. - [Update existing bill.](https://sourcey-firefly.pages.dev/api/updatebill/index.md): PUT /v1/bills/{id}: takes BillUpdate, returns BillSingle. - [Delete a bill.](https://sourcey-firefly.pages.dev/api/deletebill/index.md): Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments. - [List all transactions by a budget limit ID.](https://sourcey-firefly.pages.dev/api/listtransactionbybudgetlimit/index.md): List all the transactions within one budget limit. The start and end date are dictated by the budget limit. - [Get all limits for a budget.](https://sourcey-firefly.pages.dev/api/listbudgetlimitbybudget/index.md): Get all budget limits for this budget and the money spent, and money left. You can limit the list by submitting a date range as well. The "spent" array for each budget limit is NOT influenced by the start and end date of your query, but by the start and end date of the budget limit itself. - [Store new budget limit.](https://sourcey-firefly.pages.dev/api/storebudgetlimit/index.md): Store a new budget limit under this budget. - [Get single budget limit.](https://sourcey-firefly.pages.dev/api/getbudgetlimit/index.md): GET /v1/budgets/{id}/limits/{limitId}: returns BudgetLimitSingle. - [Update existing budget limit.](https://sourcey-firefly.pages.dev/api/updatebudgetlimit/index.md): PUT /v1/budgets/{id}/limits/{limitId}: takes BudgetLimitUpdate, returns BudgetLimitSingle. - [Delete a budget limit.](https://sourcey-firefly.pages.dev/api/deletebudgetlimit/index.md): DELETE /v1/budgets/{id}/limits/{limitId}. - [Get list of budget limits by date](https://sourcey-firefly.pages.dev/api/listbudgetlimit/index.md): Get all budget limits for for this date range. - [All transactions to a budget.](https://sourcey-firefly.pages.dev/api/listtransactionbybudget/index.md): Get all transactions linked to a budget, possibly limited by start and end - [Lists all attachments of a budget.](https://sourcey-firefly.pages.dev/api/listattachmentbybudget/index.md): Lists all attachments. - [All transactions without a budget.](https://sourcey-firefly.pages.dev/api/listtransactionwithoutbudget/index.md): Get all transactions NOT linked to a budget, possibly limited by start and end - [List all budgets.](https://sourcey-firefly.pages.dev/api/listbudget/index.md): List all the budgets the user has made. If the start date and end date are submitted as well, the "spent" array will be updated accordingly. - [Store a new budget](https://sourcey-firefly.pages.dev/api/storebudget/index.md): Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single budget.](https://sourcey-firefly.pages.dev/api/getbudget/index.md): Get a single budget. If the start date and end date are submitted as well, the "spent" array will be updated accordingly. - [Update existing budget.](https://sourcey-firefly.pages.dev/api/updatebudget/index.md): Update existing budget. This endpoint cannot be used to set budget amount limits. - [Delete a budget.](https://sourcey-firefly.pages.dev/api/deletebudget/index.md): Delete a budget. Transactions will not be deleted. - [List all transactions in a category.](https://sourcey-firefly.pages.dev/api/listtransactionbycategory/index.md): List all transactions in a category, optionally limited to the date ranges specified. - [Lists all attachments.](https://sourcey-firefly.pages.dev/api/listattachmentbycategory/index.md): GET /v1/categories/{id}/attachments: returns AttachmentArray. - [List all categories.](https://sourcey-firefly.pages.dev/api/listcategory/index.md): GET /v1/categories: returns CategoryArray. - [Store a new category](https://sourcey-firefly.pages.dev/api/storecategory/index.md): Creates a new category. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single category.](https://sourcey-firefly.pages.dev/api/getcategory/index.md): GET /v1/categories/{id}: returns CategorySingle. - [Update existing category.](https://sourcey-firefly.pages.dev/api/updatecategory/index.md): PUT /v1/categories/{id}: takes CategoryUpdate, returns CategorySingle. - [Delete a category.](https://sourcey-firefly.pages.dev/api/deletecategory/index.md): Delete a category. Transactions will not be removed. - [List all exchange rates that Firefly III knows.](https://sourcey-firefly.pages.dev/api/listcurrencyexchangerates/index.md): List exchange rates that Firefly III knows. - [Store a new currency exchange rate.](https://sourcey-firefly.pages.dev/api/storecurrencyexchangerate/index.md): Stores a new exchange rate. The data required can be submitted as a JSON body or as a list of parameters. - [List a single specific exchange rate.](https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerate/index.md): List a single specific exchange rate by its ID. - [Update existing currency exchange rate.](https://sourcey-firefly.pages.dev/api/updatecurrencyexchangerate/index.md): Used to update a single currency exchange rate by its ID. Including the from/to currency is optional. - [Delete a specific currency exchange rate.](https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerate/index.md): Delete a specific currency exchange rate by its internal ID. - [List all exchange rates from/to the mentioned currencies.](https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerates/index.md): GET /v1/exchange-rates/{from}/{to}: returns CurrencyExchangeRateArray. - [Deletes ALL currency exchange rates from 'from' to 'to'.](https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerates/index.md): Deletes ALL currency exchange rates from 'from' to 'to'. It's important to know that the reverse exchange rates (from 'to' to 'from') will not be deleted and Firefly III will still be able to infer the correct exchange rate from the reverse one. - [List the exchange rate for the from and to-currency on the requested date.](https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerateondate/index.md): GET /v1/exchange-rates/{from}/{to}/{date}: returns CurrencyExchangeRateArray. - [Update existing currency exchange rate.](https://sourcey-firefly.pages.dev/api/updatecurrencyexchangeratebydate/index.md): Used to update a single currency exchange rate by its currency codes and date - [Delete the currency exchange rate from 'from' to 'to' on the specified date.](https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerateondate/index.md): Delete the currency exchange rate from 'from' to 'to' on the specified date. It's important to know that the reverse exchange rate (from 'to' to 'from') will not be deleted and Firefly III will still be able to infer the correct exchange rate from the reverse one. - [Store new currency exchange rates under this date](https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbydate/index.md): Stores a new set of exchange rates. The date is fixed (in the URL parameter) and the data required can be submitted as a JSON body. - [Store new currency exchange rates under this from/to pair.](https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbypair/index.md): Stores a new set of exchange rates for this pair. The date is variable, and the data required can be submitted as a JSON body. - [List all transactions under this link type.](https://sourcey-firefly.pages.dev/api/listtransactionbylinktype/index.md): List all transactions under this link type, both the inward and outward transactions. - [List all types of links.](https://sourcey-firefly.pages.dev/api/listlinktype/index.md): List all the link types the system has. These include the default ones as well as any new ones. - [Create a new link type](https://sourcey-firefly.pages.dev/api/storelinktype/index.md): Creates a new link type. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform). - [Get single a link type.](https://sourcey-firefly.pages.dev/api/getlinktype/index.md): Returns a single link type by its ID. - [Update existing link type.](https://sourcey-firefly.pages.dev/api/updatelinktype/index.md): Used to update a single link type. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. You cannot update some of the system provided link types, indicated by the editable=false flag when you list it. - [Permanently delete link type.](https://sourcey-firefly.pages.dev/api/deletelinktype/index.md): Will permanently delete a link type. The links between transactions will be removed. The transactions themselves remain. You cannot delete some of the system provided link types, indicated by the editable=false flag when you list it. - [List all transaction links.](https://sourcey-firefly.pages.dev/api/listtransactionlink/index.md): List all the transaction links. - [Create a new link between transactions](https://sourcey-firefly.pages.dev/api/storetransactionlink/index.md): Store a new link between two transactions. For this end point you need the journal_id from a transaction. - [Get a single link.](https://sourcey-firefly.pages.dev/api/gettransactionlink/index.md): Returns a single link by its ID. - [Update an existing link between transactions.](https://sourcey-firefly.pages.dev/api/updatetransactionlink/index.md): Used to update a single existing link. - [Permanently delete link between transactions.](https://sourcey-firefly.pages.dev/api/deletetransactionlink/index.md): Will permanently delete link. Transactions remain. - [List all piggy banks related to the object group.](https://sourcey-firefly.pages.dev/api/listpiggybankbyobjectgroup/index.md): This endpoint returns a list of all the piggy banks connected to the object group. - [List all bills with this object group.](https://sourcey-firefly.pages.dev/api/listbillbyobjectgroup/index.md): GET /v1/object-groups/{id}/bills: returns BillArray. - [List all object groups.](https://sourcey-firefly.pages.dev/api/listobjectgroups/index.md): GET /v1/object-groups: returns ObjectGroupArray. - [Get a single object group.](https://sourcey-firefly.pages.dev/api/getobjectgroup/index.md): GET /v1/object-groups/{id}: returns ObjectGroupSingle. - [Update existing object group.](https://sourcey-firefly.pages.dev/api/updateobjectgroup/index.md): PUT /v1/object-groups/{id}: takes ObjectGroupUpdate, returns ObjectGroupSingle. - [Delete a object group.](https://sourcey-firefly.pages.dev/api/deleteobjectgroup/index.md): DELETE /v1/object-groups/{id}. - [List all events linked to a piggy bank.](https://sourcey-firefly.pages.dev/api/listeventbypiggybank/index.md): List all events linked to a piggy bank (adding and removing money). - [Lists all attachments.](https://sourcey-firefly.pages.dev/api/listattachmentbypiggybank/index.md): GET /v1/piggy-banks/{id}/attachments: returns AttachmentArray. - [List all accounts linked to a piggy bank.](https://sourcey-firefly.pages.dev/api/listaccountbypiggybank/index.md): List all accounts linked to a piggy bank. A piggy bank can be linked to multiple accounts. - [List all piggy banks.](https://sourcey-firefly.pages.dev/api/listpiggybank/index.md): GET /v1/piggy-banks: returns PiggyBankArray. - [Store a new piggy bank](https://sourcey-firefly.pages.dev/api/storepiggybank/index.md): Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single piggy bank.](https://sourcey-firefly.pages.dev/api/getpiggybank/index.md): GET /v1/piggy-banks/{id}: returns PiggyBankSingle. - [Update existing piggy bank.](https://sourcey-firefly.pages.dev/api/updatepiggybank/index.md): PUT /v1/piggy-banks/{id}: takes PiggyBankUpdate, returns PiggyBankSingle. - [Delete a piggy bank.](https://sourcey-firefly.pages.dev/api/deletepiggybank/index.md): DELETE /v1/piggy-banks/{id}. - [List all transactions created by a recurring transaction.](https://sourcey-firefly.pages.dev/api/listtransactionbyrecurrence/index.md): List all transactions created by a recurring transaction, optionally limited to the date ranges specified. - [List all recurring transactions.](https://sourcey-firefly.pages.dev/api/listrecurrence/index.md): GET /v1/recurrences: returns RecurrenceArray. - [Store a new recurring transaction](https://sourcey-firefly.pages.dev/api/storerecurrence/index.md): Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single recurring transaction.](https://sourcey-firefly.pages.dev/api/getrecurrence/index.md): GET /v1/recurrences/{id}: returns RecurrenceSingle. - [Update existing recurring transaction.](https://sourcey-firefly.pages.dev/api/updaterecurrence/index.md): PUT /v1/recurrences/{id}: takes RecurrenceUpdate, returns RecurrenceSingle. - [Delete a recurring transaction.](https://sourcey-firefly.pages.dev/api/deleterecurrence/index.md): Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted. - [Trigger the creation of a transaction for a specific recurring transaction](https://sourcey-firefly.pages.dev/api/triggerrecurrencerecurrence/index.md): Trigger the creation of a transaction for a specific recurring transaction. All recurrences have a set of future occurrences. For those moments, you can trigger the creation of the transaction. That means the transaction will be created NOW, instead of on the indicated date. The transaction will be dated to today. - [List rules in this rule group.](https://sourcey-firefly.pages.dev/api/listrulebygroup/index.md): GET /v1/rule-groups/{id}/rules: returns RuleArray. - [Test which transactions would be hit by the rule group. No changes will be made.](https://sourcey-firefly.pages.dev/api/testrulegroup/index.md): Test which transactions would be hit by the rule group. No changes will be made. Limit the result if you want to. - [Fire the rule group on your transactions.](https://sourcey-firefly.pages.dev/api/firerulegroup/index.md): Fire the rule group on your transactions. Changes will be made by the rules in the rule group. Limit the result if you want to. - [List all rule groups.](https://sourcey-firefly.pages.dev/api/listrulegroup/index.md): GET /v1/rule-groups: returns RuleGroupArray. - [Store a new rule group.](https://sourcey-firefly.pages.dev/api/storerulegroup/index.md): Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single rule group.](https://sourcey-firefly.pages.dev/api/getrulegroup/index.md): Get a single rule group. This does not include the rules. For that, see below. - [Update existing rule group.](https://sourcey-firefly.pages.dev/api/updaterulegroup/index.md): PUT /v1/rule-groups/{id}: takes RuleGroupUpdate, returns RuleGroupSingle. - [Delete a rule group.](https://sourcey-firefly.pages.dev/api/deleterulegroup/index.md): DELETE /v1/rule-groups/{id}. - [Test which transactions would be hit by the rule. No changes will be made.](https://sourcey-firefly.pages.dev/api/testrule/index.md): Test which transactions would be hit by the rule. No changes will be made. Limit the result if you want to. - [Fire the rule on your transactions.](https://sourcey-firefly.pages.dev/api/firerule/index.md): Fire the rule group on your transactions. Changes will be made by the rules in the group. Limit the result if you want to. - [List all rules.](https://sourcey-firefly.pages.dev/api/listrule/index.md): GET /v1/rules: returns RuleArray. - [Store a new rule](https://sourcey-firefly.pages.dev/api/storerule/index.md): Creates a new rule. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single rule.](https://sourcey-firefly.pages.dev/api/getrule/index.md): GET /v1/rules/{id}: returns RuleSingle. - [Update existing rule.](https://sourcey-firefly.pages.dev/api/updaterule/index.md): PUT /v1/rules/{id}: takes RuleUpdate, returns RuleSingle. - [Delete an rule.](https://sourcey-firefly.pages.dev/api/deleterule/index.md): DELETE /v1/rules/{id}. - [Validate an action expression.](https://sourcey-firefly.pages.dev/api/validateactionexpression/index.md): Validate an action expression as used in rule actions. Returns whether the submitted expression is valid. If the expression is invalid, a 422 validation error is returned instead. - [List all attachments uploaded to the subscription.](https://sourcey-firefly.pages.dev/api/listattachmentbysubscription/index.md): This endpoint will list all attachments linked to the subscription (also known as a bill). - [List all rules associated with the subscription.](https://sourcey-firefly.pages.dev/api/listrulebysubscription/index.md): This endpoint will list all rules that have an action to set the subscription (bill) to this subscription. - [List all transactions associated with the subscription.](https://sourcey-firefly.pages.dev/api/listtransactionbysubscription/index.md): This endpoint will list all transactions linked to this subscription (also known as a bill). - [List all subscriptions.](https://sourcey-firefly.pages.dev/api/listsubscription/index.md): This endpoint will list all the user's subscriptions. Subscriptions are also known as bills, and this endpoint is an alias of /bills. - [Store a new subscription](https://sourcey-firefly.pages.dev/api/storesubscription/index.md): Creates a new subscription. The data required can be submitted as a JSON body or as a list of parameters. Subscriptions are also known as bills. - [Get a single subscription.](https://sourcey-firefly.pages.dev/api/getsubscription/index.md): Get a single subscription. Subscriptions are also known as bills. - [Update existing subscription.](https://sourcey-firefly.pages.dev/api/updatesubscription/index.md): PUT /v1/subscriptions/{id}: takes BillUpdate, returns BillSingle. - [Delete a subscription.](https://sourcey-firefly.pages.dev/api/deletesubscription/index.md): Delete a subscription. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments. - [Lists all attachments.](https://sourcey-firefly.pages.dev/api/listattachmentbytag/index.md): GET /v1/tags/{tag}/attachments: returns AttachmentArray. - [List all transactions with this tag.](https://sourcey-firefly.pages.dev/api/listtransactionbytag/index.md): GET /v1/tags/{tag}/transactions: returns TransactionArray. - [List all tags.](https://sourcey-firefly.pages.dev/api/listtag/index.md): List all of the user's tags. - [Store a new tag](https://sourcey-firefly.pages.dev/api/storetag/index.md): Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single tag.](https://sourcey-firefly.pages.dev/api/gettag/index.md): GET /v1/tags/{tag}: returns TagSingle. - [Update existing tag.](https://sourcey-firefly.pages.dev/api/updatetag/index.md): PUT /v1/tags/{tag}: takes TagModelUpdate, returns TagSingle. - [Delete an tag.](https://sourcey-firefly.pages.dev/api/deletetag/index.md): DELETE /v1/tags/{tag}. - [List all accounts with this currency.](https://sourcey-firefly.pages.dev/api/listaccountbycurrency/index.md): GET /v1/currencies/{code}/accounts: returns AccountArray. - [List all available budgets with this currency.](https://sourcey-firefly.pages.dev/api/listavailablebudgetbycurrency/index.md): GET /v1/currencies/{code}/available-budgets: returns AvailableBudgetArray. - [List all bills with this currency.](https://sourcey-firefly.pages.dev/api/listbillbycurrency/index.md): GET /v1/currencies/{code}/bills: returns BillArray. - [List all budget limits with this currency](https://sourcey-firefly.pages.dev/api/listbudgetlimitbycurrency/index.md): GET /v1/currencies/{code}/budget-limits: returns BudgetLimitArray. - [List all recurring transactions with this currency.](https://sourcey-firefly.pages.dev/api/listrecurrencebycurrency/index.md): GET /v1/currencies/{code}/recurrences: returns RecurrenceArray. - [List all rules with this currency.](https://sourcey-firefly.pages.dev/api/listrulebycurrency/index.md): GET /v1/currencies/{code}/rules: returns RuleArray. - [List all transactions with this currency.](https://sourcey-firefly.pages.dev/api/listtransactionbycurrency/index.md): GET /v1/currencies/{code}/transactions: returns TransactionArray. - [List all exchange rates for this currency.](https://sourcey-firefly.pages.dev/api/listexchangeratesbycurrency/index.md): List all currency exchange rates that have this currency as the source or destination currency. - [List all currencies.](https://sourcey-firefly.pages.dev/api/listcurrency/index.md): GET /v1/currencies: returns CurrencyArray. - [Store a new currency](https://sourcey-firefly.pages.dev/api/storecurrency/index.md): Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters. - [Enable a single currency.](https://sourcey-firefly.pages.dev/api/enablecurrency/index.md): POST /v1/currencies/{code}/enable: returns CurrencySingle. - [Disable a currency.](https://sourcey-firefly.pages.dev/api/disablecurrency/index.md): POST /v1/currencies/{code}/disable: returns CurrencySingle. - [Make currency primary currency.](https://sourcey-firefly.pages.dev/api/primarycurrency/index.md): Make this currency the primary currency for the current financial administration. If the currency is not enabled, it will be enabled as well. - [Get a single currency.](https://sourcey-firefly.pages.dev/api/getcurrency/index.md): GET /v1/currencies/{code}: returns CurrencySingle. - [Update existing currency.](https://sourcey-firefly.pages.dev/api/updatecurrency/index.md): PUT /v1/currencies/{code}: takes CurrencyUpdate, returns CurrencySingle. - [Delete a currency.](https://sourcey-firefly.pages.dev/api/deletecurrency/index.md): DELETE /v1/currencies/{code}. - [Get the primary currency of the current administration.](https://sourcey-firefly.pages.dev/api/getprimarycurrency/index.md): Get the primary currency of the current administration. This replaces what was called "the user's default currency" although they are essentially the same. - [Get the default (primary) currency of the current administration.](https://sourcey-firefly.pages.dev/api/getdefaultcurrency/index.md): Get the default currency of the current administration. This is an alias of /currencies/primary. - [Lists all the transaction links for an individual journal (individual split).](https://sourcey-firefly.pages.dev/api/listlinksbyjournal/index.md): Lists all the transaction links for an individual journal (a split). Don't use the group ID, you need the actual underlying journal (the split). - [Get a single transaction, based on one of the underlying transaction journals (transaction splits).](https://sourcey-firefly.pages.dev/api/gettransactionbyjournal/index.md): Get a single transaction by underlying journal (split). - [Delete split from transaction](https://sourcey-firefly.pages.dev/api/deletetransactionjournal/index.md): Delete an individual journal (split) from a transaction. - [Lists all attachments.](https://sourcey-firefly.pages.dev/api/listattachmentbytransaction/index.md): GET /v1/transactions/{id}/attachments: returns AttachmentArray. - [Lists all piggy bank events.](https://sourcey-firefly.pages.dev/api/listeventbytransaction/index.md): GET /v1/transactions/{id}/piggy-bank-events: returns PiggyBankEventArray. - [List all the user's transactions. ](https://sourcey-firefly.pages.dev/api/listtransaction/index.md): List all the user's transactions. - [Store a new transaction](https://sourcey-firefly.pages.dev/api/storetransaction/index.md): Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters. - [Get a single transaction.](https://sourcey-firefly.pages.dev/api/gettransaction/index.md): GET /v1/transactions/{id}: returns TransactionSingle. - [Update existing transaction](https://sourcey-firefly.pages.dev/api/updatetransaction/index.md): Update an existing transaction. For more information, see Transaction update. - [Delete a transaction.](https://sourcey-firefly.pages.dev/api/deletetransaction/index.md): DELETE /v1/transactions/{id}. - [List all the user groups available to this user. ](https://sourcey-firefly.pages.dev/api/listusergroups/index.md): List all the user groups available to this user. These are essentially the 'financial administrations' that Firefly III supports. - [Get a single user group.](https://sourcey-firefly.pages.dev/api/getusergroup/index.md): Returns a single user group by its ID. - [Update an existing user group.](https://sourcey-firefly.pages.dev/api/updateusergroup/index.md): Used to update a single user group. The available fields are still limited. - [Search for accounts](https://sourcey-firefly.pages.dev/api/searchaccounts/index.md): GET /v1/search/accounts: returns AccountArray. - [Search for transactions](https://sourcey-firefly.pages.dev/api/searchtransactions/index.md): Searches through the users transactions. - [Count transactions matching the given filters.](https://sourcey-firefly.pages.dev/api/counttransactions/index.md): Returns the number of transactions that match the given meta-field filters. This is useful to check for existing transactions (for example to avoid duplicates) before storing new data. - [Returns basic sums of the users data.](https://sourcey-firefly.pages.dev/api/getbasicsummary/index.md): Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is used in Firefly III to populate the dashboard. - [System information end point.](https://sourcey-firefly.pages.dev/api/getabout/index.md): Returns general system information and versions of the (supporting) software. - [Currently authenticated user endpoint.](https://sourcey-firefly.pages.dev/api/getcurrentuser/index.md): Returns the currently authenticated user. - [Release notes endpoint.](https://sourcey-firefly.pages.dev/api/getreleasenotes/index.md): Returns the release notes for a specific version of Firefly III. - [Finish a batch of unprocessed transactions.](https://sourcey-firefly.pages.dev/api/finishbatch/index.md): summary: Finish a batch of unprocessed transactions. - [Get Firefly III system configuration values.](https://sourcey-firefly.pages.dev/api/getconfiguration/index.md): Returns all editable and not-editable configuration values for this Firefly III installation - [Get a single Firefly III system configuration value](https://sourcey-firefly.pages.dev/api/getsingleconfiguration/index.md): Returns one configuration variable for this Firefly III installation - [Update configuration value](https://sourcey-firefly.pages.dev/api/setconfiguration/index.md): Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small. - [Cron job endpoint](https://sourcey-firefly.pages.dev/api/getcron/index.md): Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint to run the cron. The cron requires the CLI token to be present. The cron job will fire for all users. - [List all users.](https://sourcey-firefly.pages.dev/api/listuser/index.md): List all the users in this instance of Firefly III. - [Store a new user](https://sourcey-firefly.pages.dev/api/storeuser/index.md): Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function. - [Get a single user.](https://sourcey-firefly.pages.dev/api/getuser/index.md): Gets all info of a single user. - [Update an existing user's information.](https://sourcey-firefly.pages.dev/api/updateuser/index.md): Update existing user. - [Delete a user.](https://sourcey-firefly.pages.dev/api/deleteuser/index.md): Delete a user. You cannot delete the user you're authenticated with. This cannot be undone. Be careful. - [List all users preferences.](https://sourcey-firefly.pages.dev/api/listpreference/index.md): List all of the preferences of the user. - [Store a new preference for this user.](https://sourcey-firefly.pages.dev/api/storepreference/index.md): This endpoint creates a new preference. The name and data are free-format, and entirely up to you. If the preference is not used in Firefly III itself it may not be configurable through the user interface, but you can use this endpoint to persist custom data for your own app. - [Return a single preference.](https://sourcey-firefly.pages.dev/api/getpreference/index.md): Return a single preference and the value. - [Update preference](https://sourcey-firefly.pages.dev/api/updatepreference/index.md): Update a user's preference. - [Get all the messages of a single webhook.](https://sourcey-firefly.pages.dev/api/getwebhookmessages/index.md): When a webhook is triggered the actual message that will be send is stored in a "message". You can view and analyse these messages. - [Get a single message from a webhook.](https://sourcey-firefly.pages.dev/api/getsinglewebhookmessage/index.md): When a webhook is triggered it will store the actual content of the webhook in a webhook message. You can view and analyse a single one using this endpoint. - [Delete a webhook message.](https://sourcey-firefly.pages.dev/api/deletewebhookmessage/index.md): Delete a webhook message. Any time a webhook is triggered the message is stored before it's sent. You can delete them before or after sending. - [Get all the failed attempts of a single webhook message.](https://sourcey-firefly.pages.dev/api/getwebhookmessageattempts/index.md): When a webhook message fails to send it will store the failure in an "attempt". You can view and analyse these. Webhook messages that receive too many attempts (failures) will not be sent again. You must first clear out old attempts before the message can go out again. - [Get a single failed attempt from a single webhook message.](https://sourcey-firefly.pages.dev/api/getsinglewebhookmessageattempt/index.md): When a webhook message fails to send it will store the failure in an "attempt". You can view and analyse these. Webhooks messages that receive too many attempts (failures) will not be fired. You must first clear out old attempts and try again. This endpoint shows you the details of a single attempt. The ID of the… - [Delete a webhook attempt.](https://sourcey-firefly.pages.dev/api/deletewebhookmessageattempt/index.md): Delete a webhook message attempt. If you delete all attempts for a webhook message, Firefly III will (once again) assume all is well with the webhook message and will try to send it again. - [Submit messages for a webhook.](https://sourcey-firefly.pages.dev/api/submitwebhook/index.md): This endpoint will submit any open messages for this webhook. This is an asynchronous operation, so you can't see the result. Refresh the webhook message and/or the webhook message attempts to see the results. This may take some time if the webhook receiver is slow. - [Trigger webhook for a given transaction.](https://sourcey-firefly.pages.dev/api/triggertransactionwebhook/index.md): This endpoint will execute this webhook for a given transaction ID. This is an asynchronous operation, so you can't see the result. Refresh the webhook message and/or the webhook message attempts to see the results. This may take some time if the webhook receiver is slow. - [List all webhooks.](https://sourcey-firefly.pages.dev/api/listwebhook/index.md): List all the user's webhooks. - [Store a new webhook](https://sourcey-firefly.pages.dev/api/storewebhook/index.md): Creates a new webhook. The data required can be submitted as a JSON body or as a list of parameters. The webhook will be given a random secret. - [Get a single webhook.](https://sourcey-firefly.pages.dev/api/getwebhook/index.md): Gets all info of a single webhook. - [Update existing webhook.](https://sourcey-firefly.pages.dev/api/updatewebhook/index.md): Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the webhook. - [Delete a webhook.](https://sourcey-firefly.pages.dev/api/deletewebhook/index.md): DELETE /v1/webhooks/{id}. - [AccountArray](https://sourcey-firefly.pages.dev/api/models/accountarray/index.md): Fields: data and meta. - [AttachmentArray](https://sourcey-firefly.pages.dev/api/models/attachmentarray/index.md): Fields: data and meta. - [AutocompleteAccountArray](https://sourcey-firefly.pages.dev/api/models/autocompleteaccountarray/index.md): A list of AutocompleteAccount. - [AutocompleteBillArray](https://sourcey-firefly.pages.dev/api/models/autocompletebillarray/index.md): A list of AutocompleteBill. - [AutocompleteBudgetArray](https://sourcey-firefly.pages.dev/api/models/autocompletebudgetarray/index.md): A list of AutocompleteBudget. - [AutocompleteCategoryArray](https://sourcey-firefly.pages.dev/api/models/autocompletecategoryarray/index.md): A list of AutocompleteCategory. - [AutocompleteCurrencyArray](https://sourcey-firefly.pages.dev/api/models/autocompletecurrencyarray/index.md): A list of AutocompleteCurrency. - [AutocompleteCurrencyCodeArray](https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycodearray/index.md): A list of AutocompleteCurrencyCode. - [AutocompleteObjectGroupArray](https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgrouparray/index.md): A list of AutocompleteObjectGroup. - [AutocompletePiggyArray](https://sourcey-firefly.pages.dev/api/models/autocompletepiggyarray/index.md): A list of AutocompletePiggy. - [AutocompletePiggyBalanceArray](https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalancearray/index.md): A list of AutocompletePiggyBalance. - [AutocompleteRecurrenceArray](https://sourcey-firefly.pages.dev/api/models/autocompleterecurrencearray/index.md): A list of AutocompleteRecurrence. - [AutocompleteRuleArray](https://sourcey-firefly.pages.dev/api/models/autocompleterulearray/index.md): A list of AutocompleteRule. - [AutocompleteRuleGroupArray](https://sourcey-firefly.pages.dev/api/models/autocompleterulegrouparray/index.md): A list of AutocompleteRuleGroup. - [AutocompleteTagArray](https://sourcey-firefly.pages.dev/api/models/autocompletetagarray/index.md): A list of AutocompleteTag. - [AutocompleteTransactionArray](https://sourcey-firefly.pages.dev/api/models/autocompletetransactionarray/index.md): A list of AutocompleteTransaction. - [AutocompleteTransactionIDArray](https://sourcey-firefly.pages.dev/api/models/autocompletetransactionidarray/index.md): A list of AutocompleteTransactionID. - [AutocompleteTransactionTypeArray](https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontypearray/index.md): A list of AutocompleteTransactionType. - [AutocompleteTransactionWithMetaArray](https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmetaarray/index.md): A list of AutocompleteTransactionWithMeta. - [AvailableBudgetArray](https://sourcey-firefly.pages.dev/api/models/availablebudgetarray/index.md): Fields: data and meta. - [BillArray](https://sourcey-firefly.pages.dev/api/models/billarray/index.md): Fields: data and meta. - [BudgetArray](https://sourcey-firefly.pages.dev/api/models/budgetarray/index.md): Fields: data and meta. - [BudgetLimitArray](https://sourcey-firefly.pages.dev/api/models/budgetlimitarray/index.md): Fields: data and meta. - [CategoryArray](https://sourcey-firefly.pages.dev/api/models/categoryarray/index.md): Fields: data and meta. - [ConfigurationArray](https://sourcey-firefly.pages.dev/api/models/configurationarray/index.md): A list of Configuration. - [CurrencyArray](https://sourcey-firefly.pages.dev/api/models/currencyarray/index.md): Fields: data, meta and links. - [CurrencyExchangeRateArray](https://sourcey-firefly.pages.dev/api/models/currencyexchangeratearray/index.md): Fields: data, meta and links. - [LinkTypeArray](https://sourcey-firefly.pages.dev/api/models/linktypearray/index.md): Fields: data, meta and links. - [ObjectGroupArray](https://sourcey-firefly.pages.dev/api/models/objectgrouparray/index.md): Fields: data and meta. - [PiggyBankArray](https://sourcey-firefly.pages.dev/api/models/piggybankarray/index.md): Fields: data, meta and links. - [PiggyBankEventArray](https://sourcey-firefly.pages.dev/api/models/piggybankeventarray/index.md): Fields: data, meta and links. - [PreferenceArray](https://sourcey-firefly.pages.dev/api/models/preferencearray/index.md): Fields: data, meta and links. - [RecurrenceArray](https://sourcey-firefly.pages.dev/api/models/recurrencearray/index.md): Fields: data, meta and links. - [RuleArray](https://sourcey-firefly.pages.dev/api/models/rulearray/index.md): Fields: data, meta and links. - [RuleGroupArray](https://sourcey-firefly.pages.dev/api/models/rulegrouparray/index.md): Fields: data, meta and links. - [TagArray](https://sourcey-firefly.pages.dev/api/models/tagarray/index.md): Fields: data, meta and links. - [TransactionArray](https://sourcey-firefly.pages.dev/api/models/transactionarray/index.md): Fields: data, meta and links. - [TransactionLinkArray](https://sourcey-firefly.pages.dev/api/models/transactionlinkarray/index.md): Fields: data, meta and links. - [UserArray](https://sourcey-firefly.pages.dev/api/models/userarray/index.md): Fields: data, meta and links. - [UserGroupArray](https://sourcey-firefly.pages.dev/api/models/usergrouparray/index.md): Fields: data, meta and links. - [WebhookArray](https://sourcey-firefly.pages.dev/api/models/webhookarray/index.md): Fields: data, meta and links. - [WebhookAttemptArray](https://sourcey-firefly.pages.dev/api/models/webhookattemptarray/index.md): Fields: data and meta. - [WebhookMessageArray](https://sourcey-firefly.pages.dev/api/models/webhookmessagearray/index.md): Fields: data and meta. - [AutocompleteAccount](https://sourcey-firefly.pages.dev/api/models/autocompleteaccount/index.md): Fields: id, name, name_with_balance, active, type, currency_id and 9 more. - [AutocompleteBill](https://sourcey-firefly.pages.dev/api/models/autocompletebill/index.md): Fields: id, name and active. - [AutocompleteBudget](https://sourcey-firefly.pages.dev/api/models/autocompletebudget/index.md): Fields: id, name and active. - [AutocompleteCategory](https://sourcey-firefly.pages.dev/api/models/autocompletecategory/index.md): Fields: id and name. - [AutocompleteCurrency](https://sourcey-firefly.pages.dev/api/models/autocompletecurrency/index.md): Fields: id, name, code, symbol and decimal_places. - [AutocompleteCurrencyCode](https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycode/index.md): Fields: id, name, code, symbol and decimal_places. - [AutocompleteObjectGroup](https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgroup/index.md): Fields: id, name and title. - [AutocompletePiggy](https://sourcey-firefly.pages.dev/api/models/autocompletepiggy/index.md): Fields: id, name, currency_id, currency_code, currency_symbol, currency_name and 3 more. - [AutocompletePiggyBalance](https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalance/index.md): Fields: id, name, name_with_balance, currency_id, currency_code, currency_symbol and 3 more. - [AutocompleteRecurrence](https://sourcey-firefly.pages.dev/api/models/autocompleterecurrence/index.md): Fields: id, name, description and active. - [AutocompleteRule](https://sourcey-firefly.pages.dev/api/models/autocompleterule/index.md): Fields: id, name, description and active. - [AutocompleteRuleGroup](https://sourcey-firefly.pages.dev/api/models/autocompleterulegroup/index.md): Fields: id, name, description and active. - [AutocompleteTag](https://sourcey-firefly.pages.dev/api/models/autocompletetag/index.md): Fields: id, name and tag. - [AutocompleteTransaction](https://sourcey-firefly.pages.dev/api/models/autocompletetransaction/index.md): Fields: id, transaction_group_id, name and description. - [AutocompleteTransactionID](https://sourcey-firefly.pages.dev/api/models/autocompletetransactionid/index.md): Fields: id, transaction_group_id, name and description. - [AutocompleteTransactionType](https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontype/index.md): Fields: id, name and type. - [AutocompleteTransactionWithMeta](https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmeta/index.md): Fields: id, transaction_group_id, name, description, date, currency_code and 1 more. - [ChartDataPoint](https://sourcey-firefly.pages.dev/api/models/chartdatapoint/index.md): Field: key. - [ChartDataSet](https://sourcey-firefly.pages.dev/api/models/chartdataset/index.md): Fields: label, currency_id, currency_name, currency_code, currency_symbol, currency_decimal_places and 13 more. - [ChartLine](https://sourcey-firefly.pages.dev/api/models/chartline/index.md): A list of ChartDataSet. - [DataDestroyObject](https://sourcey-firefly.pages.dev/api/models/datadestroyobject/index.md): One of: not_assets_liabilities, budgets, bills, piggy_banks, rules, recurring and 12 more. - [AccountSearchFieldFilter](https://sourcey-firefly.pages.dev/api/models/accountsearchfieldfilter/index.md): One of: all, iban, name, number and id. - [ConfigValueFilter](https://sourcey-firefly.pages.dev/api/models/configvaluefilter/index.md): Title of the configuration value. - [ConfigValueUpdateFilter](https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/index.md): One of: configuration.is_demo_site, configuration.permission_update_check, configuration.last_update_check, configuration.single_user_mode, configuration.enable_exchange_rates, configuration.use_running_balance and 4 more. - [ExportFileFilter](https://sourcey-firefly.pages.dev/api/models/exportfilefilter/index.md): One of: csv. - [InsightGroup](https://sourcey-firefly.pages.dev/api/models/insightgroup/index.md): A list of InsightGroupEntry. - [InsightGroupEntry](https://sourcey-firefly.pages.dev/api/models/insightgroupentry/index.md): Fields: id, name, difference, difference_float, currency_id and currency_code. - [InsightTotal](https://sourcey-firefly.pages.dev/api/models/insighttotal/index.md): A list of InsightTotalEntry. - [InsightTotalEntry](https://sourcey-firefly.pages.dev/api/models/insighttotalentry/index.md): Fields: difference, difference_float, currency_id and currency_code. - [InsightTransfer](https://sourcey-firefly.pages.dev/api/models/insighttransfer/index.md): A list of InsightTransferEntry. - [InsightTransferEntry](https://sourcey-firefly.pages.dev/api/models/insighttransferentry/index.md): Fields: id, name, difference, difference_float, in, in_float and 4 more. - [CategoryRead](https://sourcey-firefly.pages.dev/api/models/categoryread/index.md): Fields: type, id and attributes. - [CategorySingle](https://sourcey-firefly.pages.dev/api/models/categorysingle/index.md): Field: data. - [ConfigurationSingle](https://sourcey-firefly.pages.dev/api/models/configurationsingle/index.md): Field: data. - [CurrencyRead](https://sourcey-firefly.pages.dev/api/models/currencyread/index.md): Fields: type, id and attributes. - [CurrencySingle](https://sourcey-firefly.pages.dev/api/models/currencysingle/index.md): Field: data. - [LinkTypeRead](https://sourcey-firefly.pages.dev/api/models/linktyperead/index.md): Fields: type, id, attributes and links. - [LinkTypeSingle](https://sourcey-firefly.pages.dev/api/models/linktypesingle/index.md): Field: data. - [ObjectGroupRead](https://sourcey-firefly.pages.dev/api/models/objectgroupread/index.md): Fields: type, id and attributes. - [ObjectGroupSingle](https://sourcey-firefly.pages.dev/api/models/objectgroupsingle/index.md): Field: data. - [PiggyBankEventRead](https://sourcey-firefly.pages.dev/api/models/piggybankeventread/index.md): Fields: type, id, attributes and links. - [PiggyBankRead](https://sourcey-firefly.pages.dev/api/models/piggybankread/index.md): Fields: type, id, attributes and links. - [PiggyBankSingle](https://sourcey-firefly.pages.dev/api/models/piggybanksingle/index.md): Field: data. - [PreferenceRead](https://sourcey-firefly.pages.dev/api/models/preferenceread/index.md): Fields: type, id and attributes. - [PreferenceSingle](https://sourcey-firefly.pages.dev/api/models/preferencesingle/index.md): Field: data. - [RecurrenceRead](https://sourcey-firefly.pages.dev/api/models/recurrenceread/index.md): Fields: type, id, attributes and links. - [RecurrenceSingle](https://sourcey-firefly.pages.dev/api/models/recurrencesingle/index.md): Field: data. - [RuleGroupRead](https://sourcey-firefly.pages.dev/api/models/rulegroupread/index.md): Fields: type, id, attributes and links. - [RuleGroupSingle](https://sourcey-firefly.pages.dev/api/models/rulegroupsingle/index.md): Field: data. - [RuleRead](https://sourcey-firefly.pages.dev/api/models/ruleread/index.md): Fields: type, id, attributes and links. - [RuleSingle](https://sourcey-firefly.pages.dev/api/models/rulesingle/index.md): Field: data. - [TagRead](https://sourcey-firefly.pages.dev/api/models/tagread/index.md): Fields: type, id, attributes and links. - [TagSingle](https://sourcey-firefly.pages.dev/api/models/tagsingle/index.md): Field: data. - [TransactionLinkRead](https://sourcey-firefly.pages.dev/api/models/transactionlinkread/index.md): Fields: type, id, attributes and links. - [TransactionLinkSingle](https://sourcey-firefly.pages.dev/api/models/transactionlinksingle/index.md): Field: data. - [TransactionRead](https://sourcey-firefly.pages.dev/api/models/transactionread/index.md): Fields: type, id, attributes and links. - [TransactionSingle](https://sourcey-firefly.pages.dev/api/models/transactionsingle/index.md): Field: data. - [UserRead](https://sourcey-firefly.pages.dev/api/models/userread/index.md): Fields: type, id, attributes and links. - [WebhookAttemptRead](https://sourcey-firefly.pages.dev/api/models/webhookattemptread/index.md): Fields: type, id and attributes. - [WebhookAttemptSingle](https://sourcey-firefly.pages.dev/api/models/webhookattemptsingle/index.md): Field: data. - [WebhookMessageRead](https://sourcey-firefly.pages.dev/api/models/webhookmessageread/index.md): Fields: type, id and attributes. - [WebhookMessageSingle](https://sourcey-firefly.pages.dev/api/models/webhookmessagesingle/index.md): Field: data. - [WebhookRead](https://sourcey-firefly.pages.dev/api/models/webhookread/index.md): Fields: type, id, attributes and links. - [WebhookSingle](https://sourcey-firefly.pages.dev/api/models/webhooksingle/index.md): Field: data. - [AccountProperties](https://sourcey-firefly.pages.dev/api/models/accountproperties/index.md): Fields: created_at, updated_at, active, order, name, type and 42 more. - [AccountRead](https://sourcey-firefly.pages.dev/api/models/accountread/index.md): Fields: type, id and attributes. - [AccountSingle](https://sourcey-firefly.pages.dev/api/models/accountsingle/index.md): Field: data. - [AccountStore](https://sourcey-firefly.pages.dev/api/models/accountstore/index.md): Fields: name, type, iban, bic, account_number, opening_balance and 18 more. - [AccountUpdate](https://sourcey-firefly.pages.dev/api/models/accountupdate/index.md): Fields: name, iban, bic, account_number, opening_balance, opening_balance_date and 16 more. - [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md): Fields: currency_id, currency_code, currency_symbol, currency_decimal_places and sum. - [AttachmentProperties](https://sourcey-firefly.pages.dev/api/models/attachmentproperties/index.md): Fields: created_at, updated_at, attachable_type, attachable_id, hash, filename and 6 more. - [AttachmentRead](https://sourcey-firefly.pages.dev/api/models/attachmentread/index.md): Fields: type, id, attributes and links. - [AttachmentSingle](https://sourcey-firefly.pages.dev/api/models/attachmentsingle/index.md): Field: data. - [AttachmentStore](https://sourcey-firefly.pages.dev/api/models/attachmentstore/index.md): Fields: filename, attachable_type, attachable_id, title and notes. - [AttachmentUpdate](https://sourcey-firefly.pages.dev/api/models/attachmentupdate/index.md): Fields: filename, title and notes. - [AvailableBudgetProperties](https://sourcey-firefly.pages.dev/api/models/availablebudgetproperties/index.md): Fields: created_at, updated_at, object_has_currency_setting, currency_id, currency_name, currency_code and 15 more. - [AvailableBudgetRead](https://sourcey-firefly.pages.dev/api/models/availablebudgetread/index.md): Fields: type, id and attributes. - [AvailableBudgetSingle](https://sourcey-firefly.pages.dev/api/models/availablebudgetsingle/index.md): Field: data. - [BillProperties](https://sourcey-firefly.pages.dev/api/models/billproperties/index.md): Fields: created_at, updated_at, name, object_has_currency_setting, currency_id, currency_name and 29 more. - [BillRead](https://sourcey-firefly.pages.dev/api/models/billread/index.md): Fields: type, id and attributes. - [BillSingle](https://sourcey-firefly.pages.dev/api/models/billsingle/index.md): Field: data. - [BillStore](https://sourcey-firefly.pages.dev/api/models/billstore/index.md): Fields: currency_id, currency_code, name, amount_min, amount_max, date and 8 more. - [BillUpdate](https://sourcey-firefly.pages.dev/api/models/billupdate/index.md): Fields: currency_id, currency_code, name, amount_min, amount_max, date and 8 more. - [BudgetProperties](https://sourcey-firefly.pages.dev/api/models/budgetproperties/index.md): Fields: created_at, updated_at, active, name, order, notes and 20 more. - [BudgetRead](https://sourcey-firefly.pages.dev/api/models/budgetread/index.md): Fields: type, id and attributes. - [BudgetSingle](https://sourcey-firefly.pages.dev/api/models/budgetsingle/index.md): Field: data. - [BudgetStore](https://sourcey-firefly.pages.dev/api/models/budgetstore/index.md): Fields: name, active, order, notes, fire_webhooks, auto_budget_type and 4 more. - [BudgetUpdate](https://sourcey-firefly.pages.dev/api/models/budgetupdate/index.md): Fields: name, active, order, notes, fire_webhooks, auto_budget_type and 4 more. - [BudgetLimitProperties](https://sourcey-firefly.pages.dev/api/models/budgetlimitproperties/index.md): Fields: created_at, updated_at, start, end, budget_id, object_has_currency_setting and 16 more. - [BudgetLimitRead](https://sourcey-firefly.pages.dev/api/models/budgetlimitread/index.md): Fields: type, id and attributes. - [BudgetLimitSingle](https://sourcey-firefly.pages.dev/api/models/budgetlimitsingle/index.md): Field: data. - [BudgetLimitStore](https://sourcey-firefly.pages.dev/api/models/budgetlimitstore/index.md): Fields: currency_id, currency_code, budget_id, start, period, end and 3 more. - [BudgetLimitUpdate](https://sourcey-firefly.pages.dev/api/models/budgetlimitupdate/index.md): Fields: created_at, updated_at, start, end, budget_id, object_has_currency_setting and 16 more. - [CategoryProperties](https://sourcey-firefly.pages.dev/api/models/categoryproperties/index.md): Fields: created_at, updated_at, name, color, last_activity, notes and 12 more. - [CategoryStore](https://sourcey-firefly.pages.dev/api/models/categorystore/index.md): Fields: name, notes and color. - [CategoryUpdate](https://sourcey-firefly.pages.dev/api/models/categoryupdate/index.md): Fields: name, notes and color. - [CurrencyExchangeProperties](https://sourcey-firefly.pages.dev/api/models/currencyexchangeproperties/index.md): Fields: created_at, updated_at, from_currency_id, from_currency_name, from_currency_code, from_currency_symbol and 8 more. - [CurrencyExchangeRateRead](https://sourcey-firefly.pages.dev/api/models/currencyexchangerateread/index.md): Fields: type, id, attributes and links. - [CurrencyExchangeRateSingle](https://sourcey-firefly.pages.dev/api/models/currencyexchangeratesingle/index.md): Field: data. - [CurrencyExchangeRateStore](https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestore/index.md): Fields: date, from, to and rate. - [CurrencyExchangeRateStoreByDate](https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebydate/index.md): Fields: from and rates. - [CurrencyExchangeRateStoreByPair](https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebypair/index.md): The actual entries for this data set. They 'key' value is the date in YYYY-MM-DD. The value is the exchange rate. - [CurrencyExchangeRateUpdate](https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdate/index.md): Fields: date, rate, from and to. - [CurrencyExchangeRateUpdateNoDate](https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdatenodate/index.md): Field: rate. - [ObjectGroup](https://sourcey-firefly.pages.dev/api/models/objectgroup/index.md): Fields: created_at, updated_at, title and order. - [ObjectGroupUpdate](https://sourcey-firefly.pages.dev/api/models/objectgroupupdate/index.md): Fields: title and order. - [ObjectLink](https://sourcey-firefly.pages.dev/api/models/objectlink/index.md): Fields: 0 and self. - [PageLink](https://sourcey-firefly.pages.dev/api/models/pagelink/index.md): Fields: self, first, next, prev and last. - [PiggyBankAccountRead](https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/index.md): Fields: account_id, name, current_amount and pc_current_amount. - [PiggyBankAccountStore](https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/index.md): Fields: id, name and current_amount. - [PiggyBankAccountUpdate](https://sourcey-firefly.pages.dev/api/models/piggybankaccountupdate/index.md): Fields: account_id, name and current_amount. - [PiggyBankProperties](https://sourcey-firefly.pages.dev/api/models/piggybankproperties/index.md): Fields: created_at, updated_at, name, percentage, start_date, target_date and 26 more. - [PiggyBankStore](https://sourcey-firefly.pages.dev/api/models/piggybankstore/index.md): Fields: name, accounts, target_amount, current_amount, start_date, target_date and 5 more. - [PiggyBankUpdate](https://sourcey-firefly.pages.dev/api/models/piggybankupdate/index.md): Fields: name, accounts, currency_id, currency_code, target_amount, start_date and 6 more. - [PiggyBankEventProperties](https://sourcey-firefly.pages.dev/api/models/piggybankeventproperties/index.md): Fields: created_at, updated_at, amount, pc_amount, object_has_currency_setting, currency_id and 11 more. - [Preference](https://sourcey-firefly.pages.dev/api/models/preference/index.md): Fields: created_at, updated_at, name and data. - [PreferenceUpdate](https://sourcey-firefly.pages.dev/api/models/preferenceupdate/index.md): Field: data. - [RecurrenceProperties](https://sourcey-firefly.pages.dev/api/models/recurrenceproperties/index.md): Fields: created_at, updated_at, type, title, description, first_date and 8 more. - [RecurrenceStore](https://sourcey-firefly.pages.dev/api/models/recurrencestore/index.md): Fields: type, title, description, first_date, repeat_until, nr_of_repetitions and 5 more. - [RecurrenceUpdate](https://sourcey-firefly.pages.dev/api/models/recurrenceupdate/index.md): Fields: title, description, first_date, repeat_until, nr_of_repetitions, apply_rules and 4 more. - [RecurrenceRepetition](https://sourcey-firefly.pages.dev/api/models/recurrencerepetition/index.md): Fields: id, created_at, updated_at, type, moment, skip and 3 more. - [RecurrenceRepetitionStore](https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionstore/index.md): Fields: type, moment, skip and weekend. - [RecurrenceRepetitionUpdate](https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionupdate/index.md): Fields: type, moment, skip and weekend. - [RecurrenceTransaction](https://sourcey-firefly.pages.dev/api/models/recurrencetransaction/index.md): Fields: id, description, object_has_currency_setting, currency_id, currency_name, currency_code and 33 more. - [RecurrenceTransactionStore](https://sourcey-firefly.pages.dev/api/models/recurrencetransactionstore/index.md): Fields: description, amount, foreign_amount, currency_id, currency_code, foreign_currency_id and 8 more. - [RecurrenceTransactionUpdate](https://sourcey-firefly.pages.dev/api/models/recurrencetransactionupdate/index.md): Fields: id, description, amount, foreign_amount, currency_id, currency_code and 8 more. - [Rule](https://sourcey-firefly.pages.dev/api/models/rule/index.md): Fields: created_at, updated_at, title, description, rule_group_id, rule_group_title and 7 more. - [RuleStore](https://sourcey-firefly.pages.dev/api/models/rulestore/index.md): Fields: title, description, rule_group_id, rule_group_title, order, trigger and 5 more. - [RuleUpdate](https://sourcey-firefly.pages.dev/api/models/ruleupdate/index.md): Fields: title, description, rule_group_id, order, trigger, active and 4 more. - [RuleAction](https://sourcey-firefly.pages.dev/api/models/ruleaction/index.md): Fields: id, created_at, updated_at, type, value, order and 2 more. - [RuleActionStore](https://sourcey-firefly.pages.dev/api/models/ruleactionstore/index.md): Fields: type, value, order, active and stop_processing. - [RuleActionUpdate](https://sourcey-firefly.pages.dev/api/models/ruleactionupdate/index.md): Fields: type, value, order, active and stop_processing. - [RuleGroup](https://sourcey-firefly.pages.dev/api/models/rulegroup/index.md): Fields: created_at, updated_at, title, description, order and active. - [RuleGroupStore](https://sourcey-firefly.pages.dev/api/models/rulegroupstore/index.md): Fields: title, description, order and active. - [RuleGroupUpdate](https://sourcey-firefly.pages.dev/api/models/rulegroupupdate/index.md): Fields: title, description, order and active. - [RuleTrigger](https://sourcey-firefly.pages.dev/api/models/ruletrigger/index.md): Fields: id, created_at, updated_at, type, value, prohibited and 3 more. - [RuleTriggerStore](https://sourcey-firefly.pages.dev/api/models/ruletriggerstore/index.md): Fields: type, value, order, active, prohibited and stop_processing. - [RuleTriggerUpdate](https://sourcey-firefly.pages.dev/api/models/ruletriggerupdate/index.md): Fields: type, value, order, active and stop_processing. - [TagModel](https://sourcey-firefly.pages.dev/api/models/tagmodel/index.md): Fields: created_at, updated_at, tag, date, description, latitude and 2 more. - [TagModelStore](https://sourcey-firefly.pages.dev/api/models/tagmodelstore/index.md): Fields: tag, date, description, latitude, longitude and zoom_level. - [TagModelUpdate](https://sourcey-firefly.pages.dev/api/models/tagmodelupdate/index.md): Fields: tag, date, description, latitude, longitude and zoom_level. - [CurrencyProperties](https://sourcey-firefly.pages.dev/api/models/currencyproperties/index.md): Fields: created_at, updated_at, enabled, primary, code, name and 2 more. - [CurrencyStore](https://sourcey-firefly.pages.dev/api/models/currencystore/index.md): Fields: enabled, primary, code, name, symbol and decimal_places. - [CurrencyUpdate](https://sourcey-firefly.pages.dev/api/models/currencyupdate/index.md): Fields: enabled, primary, code, name, symbol and decimal_places. - [Transaction](https://sourcey-firefly.pages.dev/api/models/transaction/index.md): Fields: created_at, updated_at, user, group_title and transactions. - [TransactionStore](https://sourcey-firefly.pages.dev/api/models/transactionstore/index.md): Fields: error_if_duplicate_hash, apply_rules, fire_webhooks, group_title and transactions. - [TransactionUpdate](https://sourcey-firefly.pages.dev/api/models/transactionupdate/index.md): Fields: apply_rules, fire_webhooks, group_title and transactions. - [TransactionLink](https://sourcey-firefly.pages.dev/api/models/transactionlink/index.md): Fields: created_at, updated_at, link_type_id, link_type_name, inward_id, outward_id and 1 more. - [TransactionLinkStore](https://sourcey-firefly.pages.dev/api/models/transactionlinkstore/index.md): Fields: link_type_id, link_type_name, inward_id, outward_id and notes. - [TransactionLinkUpdate](https://sourcey-firefly.pages.dev/api/models/transactionlinkupdate/index.md): Fields: link_type_id, link_type_name, inward_id, outward_id and notes. - [LinkType](https://sourcey-firefly.pages.dev/api/models/linktype/index.md): Fields: name, inward, outward and editable. - [LinkTypeUpdate](https://sourcey-firefly.pages.dev/api/models/linktypeupdate/index.md): Fields: name, inward and outward. - [TransactionSplit](https://sourcey-firefly.pages.dev/api/models/transactionsplit/index.md): Fields: user, transaction_journal_id, type, date, order, object_has_currency_setting and 67 more. - [TransactionSplitStore](https://sourcey-firefly.pages.dev/api/models/transactionsplitstore/index.md): Fields: type, date, amount, description, order, currency_id and 36 more. - [TransactionSplitUpdate](https://sourcey-firefly.pages.dev/api/models/transactionsplitupdate/index.md): Fields: transaction_journal_id, type, date, amount, description, order and 42 more. - [User](https://sourcey-firefly.pages.dev/api/models/user/index.md): Fields: created_at, updated_at, email, blocked, blocked_code and role. - [UserGroupRead](https://sourcey-firefly.pages.dev/api/models/usergroupread/index.md): Fields: type, id, attributes and links. - [UserGroupReadAttributes](https://sourcey-firefly.pages.dev/api/models/usergroupreadattributes/index.md): Fields: created_at, updated_at, in_use, can_see_members, title, primary_currency_id and 4 more. - [UserGroupReadMembers](https://sourcey-firefly.pages.dev/api/models/usergroupreadmembers/index.md): Fields: user_id, user_email, you and roles. - [UserGroupReadRole](https://sourcey-firefly.pages.dev/api/models/usergroupreadrole/index.md): The possible roles of the user in this user group are documented in the API reference guide. - [UserGroupSingle](https://sourcey-firefly.pages.dev/api/models/usergroupsingle/index.md): Field: data. - [UserGroupUpdate](https://sourcey-firefly.pages.dev/api/models/usergroupupdate/index.md): Fields: title, primary_currency_id and primary_currency_code. - [WebhookDelivery](https://sourcey-firefly.pages.dev/api/models/webhookdelivery/index.md): Format of the delivered response. - [WebhookDeliveryArray](https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/index.md): A list of WebhookDelivery. - [WebhookProperties](https://sourcey-firefly.pages.dev/api/models/webhookproperties/index.md): Fields: created_at, updated_at, active, title, secret, triggers and 3 more. - [WebhookResponse](https://sourcey-firefly.pages.dev/api/models/webhookresponse/index.md): Indicator for what Firefly III will deliver to the webhook URL. - [WebhookResponseArray](https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/index.md): A list of WebhookResponse. - [WebhookStore](https://sourcey-firefly.pages.dev/api/models/webhookstore/index.md): Fields: active, title, triggers, responses, deliveries and url. - [WebhookTrigger](https://sourcey-firefly.pages.dev/api/models/webhooktrigger/index.md): The trigger for the webhook. - [WebhookTriggerArray](https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/index.md): A list of WebhookTrigger. - [WebhookUpdate](https://sourcey-firefly.pages.dev/api/models/webhookupdate/index.md): Fields: active, title, secret, triggers, responses, deliveries and 1 more. - [WebhookAttempt](https://sourcey-firefly.pages.dev/api/models/webhookattempt/index.md): Fields: created_at, updated_at, webhook_message_id, status_code, logs and response. - [WebhookMessage](https://sourcey-firefly.pages.dev/api/models/webhookmessage/index.md): Fields: created_at, updated_at, sent, errored, webhook_id, uuid and 1 more. - [AttachableType](https://sourcey-firefly.pages.dev/api/models/attachabletype/index.md): The object class to which the attachment must be linked. - [AutoBudgetPeriod](https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/index.md): Period for the auto budget - [AutoBudgetType](https://sourcey-firefly.pages.dev/api/models/autobudgettype/index.md): The type of auto-budget that Firefly III must create. - [BillRepeatFrequency](https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/index.md): How often the bill must be paid. - [PolymorphicProperty](https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/index.md): PolymorphicProperty - [RecurrenceRepetitionType](https://sourcey-firefly.pages.dev/api/models/recurrencerepetitiontype/index.md): The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. - [RecurrenceTransactionType](https://sourcey-firefly.pages.dev/api/models/recurrencetransactiontype/index.md): One of: withdrawal, transfer and deposit. - [RuleActionKeyword](https://sourcey-firefly.pages.dev/api/models/ruleactionkeyword/index.md): The type of thing this action will do. A limited set is possible. - [RuleTriggerKeyword](https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/index.md): The type of thing this trigger responds to. A limited set is possible - [RuleTriggerType](https://sourcey-firefly.pages.dev/api/models/ruletriggertype/index.md): Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. - [StringArrayItem](https://sourcey-firefly.pages.dev/api/models/stringarrayitem/index.md): The actual preference content. - [UserBlockedCodeProperty](https://sourcey-firefly.pages.dev/api/models/userblockedcodeproperty/index.md): If you say the user must be blocked, this will be the reason code. - [UserRoleProperty](https://sourcey-firefly.pages.dev/api/models/userroleproperty/index.md): Role for the user. Can be empty or omitted. - [BasicSummary](https://sourcey-firefly.pages.dev/api/models/basicsummary/index.md): BasicSummary - [BasicSummaryEntry](https://sourcey-firefly.pages.dev/api/models/basicsummaryentry/index.md): Fields: key, title, monetary_value, currency_id, currency_code, currency_symbol and 4 more. - [Configuration](https://sourcey-firefly.pages.dev/api/models/configuration/index.md): Fields: title, value and editable. - [ConfigurationUpdate](https://sourcey-firefly.pages.dev/api/models/configurationupdate/index.md): Field: value. - [CronResult](https://sourcey-firefly.pages.dev/api/models/cronresult/index.md): Fields: recurring_transactions, auto_budgets, exchange_rates, bill_notifications and webhooks. - [CronResultRow](https://sourcey-firefly.pages.dev/api/models/cronresultrow/index.md): Fields: job_fired, job_succeeded, job_errored, message and user. - [ReleaseNotes](https://sourcey-firefly.pages.dev/api/models/releasenotes/index.md): Fields: version, release_notes and release_notes_markdown. - [SystemInfo](https://sourcey-firefly.pages.dev/api/models/systeminfo/index.md): Field: data. - [UserSingle](https://sourcey-firefly.pages.dev/api/models/usersingle/index.md): Field: data. - [AccountTypeFilter](https://sourcey-firefly.pages.dev/api/models/accounttypefilter/index.md): One of: all, asset, cash, expense, revenue, special and 15 more. - [TransactionTypeFilter](https://sourcey-firefly.pages.dev/api/models/transactiontypefilter/index.md): One of: all, withdrawal, withdrawals, expense, deposit, deposits and 8 more. - [Meta](https://sourcey-firefly.pages.dev/api/models/meta/index.md): Field: pagination. - [AccountRoleProperty](https://sourcey-firefly.pages.dev/api/models/accountroleproperty/index.md): Is only mandatory when the type is asset. - [AccountTypeProperty](https://sourcey-firefly.pages.dev/api/models/accounttypeproperty/index.md): One of: Default account, Cash account, Asset account, Expense account, Revenue account, Initial balance account and 6 more. - [ChartDatasetPeriodProperty](https://sourcey-firefly.pages.dev/api/models/chartdatasetperiodproperty/index.md): Period of the chart. - [CreditCardTypeProperty](https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/index.md): Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. - [InterestPeriodProperty](https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/index.md): Mandatory when type is liability. Period over which the interest is calculated. - [LiabilityDirectionProperty](https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/index.md): 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. - [LiabilityTypeProperty](https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/index.md): Mandatory when type is liability. Specifies the exact type. - [ShortAccountTypeProperty](https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/index.md): Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. - [TransactionTypeProperty](https://sourcey-firefly.pages.dev/api/models/transactiontypeproperty/index.md): One of: withdrawal, deposit, transfer, reconciliation and opening balance. - [BadRequestResponse](https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md): Fields: message and exception. - [InternalExceptionResponse](https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md): Fields: message and exception. - [NotFoundResponse](https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md): Fields: message and exception. - [UnauthenticatedResponse](https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md): Fields: message and exception. - [ValidationErrorResponse](https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md): Fields: message and errors.